Cisco-IOS-XR-ip-rsvp-oper API API Reference
API generated from Cisco-IOS-XR-ip-rsvp-oper@2017-09-07.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Paths
RSVP-STANDBY - Retrieve
Retrieve operation of resource: rsvp-standby
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-briefs": {
"global-neighbor-brief": [
{
"neighbor-address": "string",
"restart-state": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"lost-communication-total": [
{
"entry": "integer"
}
],
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"is-gr-enabled": "boolean",
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"node-address": "string",
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
]
}
}
INTERFACE-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: interface-neighbor-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-brief": [
{
"interface-neighbor-list-compact": [
{
"neighbor-interface-name": "string",
"interface-neighbor-address": "string"
}
],
"node-address": "string"
}
]
}
INTERFACE-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: interface-neighbor-brief
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-list-compact": [
{
"neighbor-interface-name": "string",
"interface-neighbor-address": "string"
}
],
"node-address": "string"
}
INTERFACE-NEIGHBOR-LIST-COMPACT - Retrieve
Retrieve operation of resource: interface-neighbor-list-compact
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-interface-name": "string",
"interface-neighbor-address": "string"
}
CONTROLLER-SUMMARIES - Retrieve
Retrieve operation of resource: controller-summaries
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-summary": [
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
]
}
CONTROLLER-SUMMARY - Retrieve
Retrieve operation of resource: controller-summary
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
AUTHENTICATION-BRIEFS - Retrieve
Retrieve operation of resource: authentication-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-brief": [
{
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
}
]
}
AUTHENTICATION-BRIEF - Retrieve
Retrieve operation of resource: authentication-brief
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
}
SESSION-BRIEFS - Retrieve
Retrieve operation of resource: session-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-brief": [
{
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
}
]
}
SESSION-BRIEF - Retrieve
Retrieve operation of resource: session-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
PSB-DETAILEDS - Retrieve
Retrieve operation of resource: psb-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-detailed": [
{
"input-interface": "string",
"in-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"is-out-ero-valid": "boolean",
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"policy-source-info": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"out-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"backup-tunnel-name": "string",
"policy-query-flags": {
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
}
}
]
}
PSB-DETAILED - Retrieve
Retrieve operation of resource: psb-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-interface": "string",
"in-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"is-out-ero-valid": "boolean",
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"policy-source-info": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"out-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"backup-tunnel-name": "string",
"policy-query-flags": {
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
PATH-FLAGS - Retrieve
Retrieve operation of resource: path-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bidirectional": "boolean",
"is-lockout": "boolean",
"is-non-rsvp-hop-upstream": "boolean",
"is-message-id-valid": "boolean",
"is-local-sender": "boolean",
"is-local-repair": "boolean"
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
}
POLICY-SOURCE-INFO - Retrieve
Retrieve operation of resource: policy-source-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
CLASS-TYPE - Retrieve
Retrieve operation of resource: class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-class-type-info-valid": "boolean",
"class-type": "integer"
}
PFC - Retrieve
Retrieve operation of resource: pfc
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": {
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
},
"output-interface": "string",
"policy-query-flags": {
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
IN-ERO - Retrieve
Retrieve operation of resource: in-ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
}
OUT-ERO - Retrieve
Retrieve operation of resource: out-ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
}
CONTROLLER-DETAILEDS - Retrieve
Retrieve operation of resource: controller-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-detailed": [
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
]
}
CONTROLLER-DETAILED - Retrieve
Retrieve operation of resource: controller-detailed
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-id": "string"
}
FRR-SUMMARY - Retrieve
Retrieve operation of resource: frr-summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-states": {
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
},
"path-states": {
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
}
}
PATH-STATES - Retrieve
Retrieve operation of resource: path-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
}
RESERVATION-STATES - Retrieve
Retrieve operation of resource: reservation-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
}
RSB-DETAILEDS - Retrieve
Retrieve operation of resource: rsb-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-detailed": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"label-info": {
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
},
"input-adjusted-interface": "string",
"filter": {}
}
]
}
RSB-DETAILED - Retrieve
Retrieve operation of resource: rsb-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"label-info": {
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
},
"input-adjusted-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {}
}
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-type": "string"
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
RSB-FLAGS - Retrieve
Retrieve operation of resource: rsb-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-lockout": "boolean",
"is-merge-point": "boolean",
"is-local-receiver": "boolean",
"is-message-id-valid": "boolean",
"is-local-repair": "boolean"
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
INTERFACE-SUMMARIES - Retrieve
Retrieve operation of resource: interface-summaries
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-summary": [
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
]
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
HELLO-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-instance-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-brief": [
{
"lost-communication-total": "integer",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"neighbor-hello-state": "string",
"instance-type": "string"
}
]
}
HELLO-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-instance-brief
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-total": "integer",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"neighbor-hello-state": "string",
"instance-type": "string"
}
AUTHENTICATION-DETAILS - Retrieve
Retrieve operation of resource: authentication-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-detail": [
{
"lifetime-left": "integer",
"challenge-status": "string",
"key-digest-info": "integer",
"key-status": "integer",
"auth-compact": {
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
},
"direction-info": {
"receive-info": {
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
},
"send-info": {
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
},
"auth-direction": "string"
},
"lifetime": "integer"
}
]
}
AUTHENTICATION-DETAIL - Retrieve
Retrieve operation of resource: authentication-detail
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lifetime-left": "integer",
"challenge-status": "string",
"key-digest-info": "integer",
"key-status": "integer",
"auth-compact": {
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
},
"direction-info": {
"receive-info": {
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
},
"send-info": {
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
},
"auth-direction": "string"
},
"lifetime": "integer"
}
AUTH-COMPACT - Retrieve
Retrieve operation of resource: auth-compact
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
}
DIRECTION-INFO - Retrieve
Retrieve operation of resource: direction-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"receive-info": {
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
},
"send-info": {
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
},
"auth-direction": "string"
}
SEND-INFO - Retrieve
Retrieve operation of resource: send-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
RECEIVE-INFO - Retrieve
Retrieve operation of resource: receive-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
SEQUENCE-WINDOW - Retrieve
Retrieve operation of resource: sequence-window
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
RSB-BRIEFS - Retrieve
Retrieve operation of resource: rsb-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-brief": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
]
}
RSB-BRIEF - Retrieve
Retrieve operation of resource: rsb-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-type": "string"
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-messages": {
"interface-message": [
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
]
},
"message-summary": {
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer"
}
}
}
INTERFACE-MESSAGES - Retrieve
Retrieve operation of resource: interface-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-message": [
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
]
}
INTERFACE-MESSAGE - Retrieve
Retrieve operation of resource: interface-message
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
MESSAGE-SUMMARY - Retrieve
Retrieve operation of resource: message-summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
PREFIX-FILTERING - Retrieve
Retrieve operation of resource: prefix-filtering
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {
"interfaces": {
"interface": [
{
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
]
},
"summary": {
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
},
"accesses": {
"access": [
{
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer"
}
}
]
}
}
ACCESSES - Retrieve
Retrieve operation of resource: accesses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"access": [
{
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
]
}
ACCESS - Retrieve
Retrieve operation of resource: access
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
TOTAL - Retrieve
Retrieve operation of resource: total
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"dropped-path-messages": "integer"
}
]
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
TOTAL - Retrieve
Retrieve operation of resource: total
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"dropped-path-messages": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
TOTAL - Retrieve
Retrieve operation of resource: total
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
OUT-OF-RESOURCE - Retrieve
Retrieve operation of resource: out-of-resource
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {
"interfaces": {
"interface": [
{
"dropped-path-messages": "integer"
}
]
},
"summary": {
"dropped-path-messages": "integer"
}
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"dropped-path-messages": "integer"
}
]
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped-path-messages": "integer"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"dropped-path-messages": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped-path-messages": "integer"
}
INTERFACE-EVENTS - Retrieve
Retrieve operation of resource: interface-events
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-event": [
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
]
}
INTERFACE-EVENT - Retrieve
Retrieve operation of resource: interface-event
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
NSR - Retrieve
Retrieve operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-id-ts": "integer",
"last-cleared-timestamp": "integer",
"total-states": "integer",
"last-idt-states": "integer",
"total-deletions": "integer",
"rsvp-process-role": "string",
"total-nacks": "integer"
}
ISSU - Retrieve
Retrieve operation of resource: issu
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-id-ts": "integer",
"last-cleared-timestamp": "integer",
"total-states": "integer",
"last-idt-states": "integer",
"total-deletions": "integer",
"rsvp-process-role": "string",
"total-nacks": "integer"
}
DATABASE - Retrieve
Retrieve operation of resource: database
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"incoming-paths": "integer",
"sessions": "integer",
"interfaces": "integer",
"outgoing-paths": "integer",
"outgoing-reservations": "integer",
"incoming-reservations": "integer"
}
EVENT-SYNCS - Retrieve
Retrieve operation of resource: event-syncs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"event-sync": [
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
]
}
EVENT-SYNC - Retrieve
Retrieve operation of resource: event-sync
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
INTERFACE-DETAILEDS - Retrieve
Retrieve operation of resource: interface-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-detailed": [
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
]
}
INTERFACE-DETAILED - Retrieve
Retrieve operation of resource: interface-detailed
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-id": "string"
}
CONTROLLER-BRIEFS - Retrieve
Retrieve operation of resource: controller-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-brief": [
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
]
}
CONTROLLER-BRIEF - Retrieve
Retrieve operation of resource: controller-brief
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"missed-hellos": "integer",
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-interval": "integer",
"global-neighbors": "integer",
"is-gr-enabled": "boolean",
"local-node-address": [
{
"local-node-ip-address": "string",
"application-type": "string"
}
],
"recovery-time": "integer",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
},
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer"
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-node-ip-address": "string",
"application-type": "string"
}
HELLO-INTERFACE-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-interface-instance-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-brief": [
{
"instance-type": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string"
}
]
}
HELLO-INTERFACE-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-interface-instance-brief
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"instance-type": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string"
}
HELLO-INTERFACE-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-interface-instance-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-detail": [
{
"last-message-sent-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-messages-received": "integer",
"hello-global-neighbor-id": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"destination-instance": "integer",
"instance-type": "string",
"source-instance": "integer",
"hello-messages-sent": "integer"
}
]
}
HELLO-INTERFACE-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-interface-instance-detail
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-message-sent-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-messages-received": "integer",
"hello-global-neighbor-id": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"destination-instance": "integer",
"instance-type": "string",
"source-instance": "integer",
"hello-messages-sent": "integer"
}
LAST-MESSAGE-SENT-TIME - Retrieve
Retrieve operation of resource: last-message-sent-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
INTERFACE-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: interface-neighbor-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-detail": [
{
"interface-neighbor-list-detail": [
{
"retransmitted-messages": "integer",
"neighbor-interface-name": "string",
"is-rr-enabled": "boolean",
"neighbor-epoch": "integer",
"interface-neighbor-address": "string",
"out-of-order-messages": "integer"
}
],
"node-address": "string"
}
]
}
INTERFACE-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-list-detail": [
{
"retransmitted-messages": "integer",
"neighbor-interface-name": "string",
"is-rr-enabled": "boolean",
"neighbor-epoch": "integer",
"interface-neighbor-address": "string",
"out-of-order-messages": "integer"
}
],
"node-address": "string"
}
INTERFACE-NEIGHBOR-LIST-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-list-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retransmitted-messages": "integer",
"neighbor-interface-name": "string",
"is-rr-enabled": "boolean",
"neighbor-epoch": "integer",
"interface-neighbor-address": "string",
"out-of-order-messages": "integer"
}
NSR - Retrieve
Retrieve operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
}
STATUS - Retrieve
Retrieve operation of resource: status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ls-ps": "integer",
"interfaces": "integer",
"issu-status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
},
"database-counters": {
"incoming-paths": "integer",
"sessions": "integer",
"interfaces": "integer",
"outgoing-paths": "integer",
"outgoing-reservations": "integer",
"incoming-reservations": "integer"
},
"nsr-status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
}
ISSU-STATUS - Retrieve
Retrieve operation of resource: issu-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
NSR-STATUS - Retrieve
Retrieve operation of resource: nsr-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
DATABASE-COUNTERS - Retrieve
Retrieve operation of resource: database-counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"incoming-paths": "integer",
"sessions": "integer",
"interfaces": "integer",
"outgoing-paths": "integer",
"outgoing-reservations": "integer",
"incoming-reservations": "integer"
}
FRRS - Retrieve
Retrieve operation of resource: frrs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frr": [
{
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"reservation-status": "string",
"path-status": "string"
}
]
}
FRR - Retrieve
Retrieve operation of resource: frr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"reservation-status": "string",
"path-status": "string"
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
REQUEST-BRIEFS - Retrieve
Retrieve operation of resource: request-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-brief": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"output-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
]
}
REQUEST-BRIEF - Retrieve
Retrieve operation of resource: request-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"output-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-type": "string"
}
REQUEST-DETAILS - Retrieve
Retrieve operation of resource: request-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-detail": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"psb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"rsb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"req-flags": {
"is-rro-in-path": "boolean",
"is-send-confirm": "boolean",
"is-merge-point": "boolean",
"is-refreshing": "boolean",
"is-ack-outstanding": "boolean",
"is-retransmit": "boolean",
"is-label-request-in-path": "boolean",
"is-nack-received": "boolean",
"is-record-label-in-path": "boolean",
"is-message-id-allocated": "boolean",
"is-paced": "boolean",
"is-local-receiver": "boolean"
},
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {}
}
}
}
]
}
REQUEST-DETAIL - Retrieve
Retrieve operation of resource: request-detail
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"psb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"rsb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"req-flags": {
"is-rro-in-path": "boolean",
"is-send-confirm": "boolean",
"is-merge-point": "boolean",
"is-refreshing": "boolean",
"is-ack-outstanding": "boolean",
"is-retransmit": "boolean",
"is-label-request-in-path": "boolean",
"is-nack-received": "boolean",
"is-record-label-in-path": "boolean",
"is-message-id-allocated": "boolean",
"is-paced": "boolean",
"is-local-receiver": "boolean"
},
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
}
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-type": "string"
}
REQ-FLAGS - Retrieve
Retrieve operation of resource: req-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-rro-in-path": "boolean",
"is-send-confirm": "boolean",
"is-merge-point": "boolean",
"is-refreshing": "boolean",
"is-ack-outstanding": "boolean",
"is-retransmit": "boolean",
"is-label-request-in-path": "boolean",
"is-nack-received": "boolean",
"is-record-label-in-path": "boolean",
"is-message-id-allocated": "boolean",
"is-paced": "boolean",
"is-local-receiver": "boolean"
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
PSB-KEY - Retrieve
Retrieve operation of resource: psb-key
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
RSB-KEY - Retrieve
Retrieve operation of resource: rsb-key
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
INTERFACE-BRIEFS - Retrieve
Retrieve operation of resource: interface-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-brief": [
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
]
}
INTERFACE-BRIEF - Retrieve
Retrieve operation of resource: interface-brief
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
SESSION-DETAILEDS - Retrieve
Retrieve operation of resource: session-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-detailed": [
{
"compact": {
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"psb-rsb-info": [
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
}
]
}
]
}
]
}
SESSION-DETAILED - Retrieve
Retrieve operation of resource: session-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"compact": {
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"psb-rsb-info": [
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer"
}
}
}
]
}
]
}
COMPACT - Retrieve
Retrieve operation of resource: compact
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
PSB-RSB-INFO - Retrieve
Retrieve operation of resource: psb-rsb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"p2mp-sub-group-origin": "string",
"reverse-lsp": {
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
]
}
}
]
}
PSB-INFO - Retrieve
Retrieve operation of resource: psb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"p2mp-sub-group-origin": "string",
"reverse-lsp": {
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"unsup-sub-object": [
{}
]
}
}
GENERIC-IN-LABEL - Retrieve
Retrieve operation of resource: generic-in-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
ASSOCIATION - Retrieve
Retrieve operation of resource: association
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-ipv4": {
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
},
"extended-ipv6": {
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
},
"ipv4": {
"source": "string",
"type": "integer",
"id": "integer"
},
"association-type": "string",
"ipv6": {
"source": "string",
"type": "integer",
"id": "integer"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": "string",
"type": "integer",
"id": "integer"
}
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": "string",
"type": "integer",
"id": "integer"
}
EXTENDED-IPV4 - Retrieve
Retrieve operation of resource: extended-ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
EXTENDED-IPV6 - Retrieve
Retrieve operation of resource: extended-ipv6
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
PROTECTION - Retrieve
Retrieve operation of resource: protection
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-flags": {
"reserved-bit2": "boolean",
"reserved-bit1": "boolean",
"unprotected": "boolean",
"ded1-plus1": "boolean",
"enhanced": "boolean",
"shared": "boolean",
"extra-traffic": "boolean",
"ded1-to1": "boolean"
},
"s": "boolean",
"o": "boolean",
"n": "boolean",
"p": "boolean",
"lsp-flags": {
"rerouting-no-et": "boolean",
"one-plus-one-uni": "boolean",
"one-plus-one-bi": "boolean",
"rerouting": "boolean",
"one-to-n-protection-et": "boolean"
}
}
LSP-FLAGS - Retrieve
Retrieve operation of resource: lsp-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rerouting-no-et": "boolean",
"one-plus-one-uni": "boolean",
"one-plus-one-bi": "boolean",
"rerouting": "boolean",
"one-to-n-protection-et": "boolean"
}
LINK-FLAGS - Retrieve
Retrieve operation of resource: link-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reserved-bit2": "boolean",
"reserved-bit1": "boolean",
"unprotected": "boolean",
"ded1-plus1": "boolean",
"enhanced": "boolean",
"shared": "boolean",
"extra-traffic": "boolean",
"ded1-to1": "boolean"
}
REVERSE-LSP - Retrieve
Retrieve operation of resource: reverse-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"unsup-sub-object": [
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{
"entry": "integer"
}
]
}
]
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
ERO - Retrieve
Retrieve operation of resource: ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
}
UNSUP-SUB-OBJECT - Retrieve
Retrieve operation of resource: unsup-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{
"entry": "integer"
}
]
}
RSVP-MGMT-REV-LSP-UNSUPPORTED-SUBOBJ - Retrieve
Retrieve operation of resource: rsvp-mgmt-rev-lsp-unsupported-subobj
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
ERO - Retrieve
Retrieve operation of resource: ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
}
RRO - Retrieve
Retrieve operation of resource: rro
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-global-label": "boolean"
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srl-gs": [
{
"entry": "integer"
}
]
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
RSB-INFO - Retrieve
Retrieve operation of resource: rsb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-out-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"out-interface": "string",
"is-valid": "boolean",
"is-flow-spec-valid": "boolean",
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-rro-valid": "boolean",
"destination-address": "string",
"backup-label": "string",
"out-label": "string",
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
},
"backup-interface": "string"
}
GENERIC-OUT-LABEL - Retrieve
Retrieve operation of resource: generic-out-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
RRO - Retrieve
Retrieve operation of resource: rro
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-global-label": "boolean"
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srl-gs": [
{
"entry": "integer"
}
]
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
HELLO-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-instance-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-detail": [
{
"communication-lost-wrong-source-inst": "integer",
"communication-lost-reason": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"destination-instance": "integer",
"instance-type": "string",
"communication-lost-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-request-suppressed": "integer",
"communication-lost-hello-missed": "integer",
"missed-acks-allowed": "integer",
"communication-lost-neighbor-disabled-hello": "integer",
"total-communication-lost": "integer",
"communication-lost-interface-down": "integer",
"neighbor-hello-state": "string",
"hello-interval": "integer",
"source-address-xr": "string",
"source-instance": "integer",
"hello-messages-received": "integer",
"hello-instance-owner": "string",
"up-time": {
"seconds": "string",
"nanoseconds": "string"
},
"communication-lost-wrong-destination-inst": "integer",
"hello-messages-sent": "integer"
}
]
}
HELLO-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-instance-detail
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"communication-lost-wrong-source-inst": "integer",
"communication-lost-reason": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"destination-instance": "integer",
"instance-type": "string",
"communication-lost-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-request-suppressed": "integer",
"communication-lost-hello-missed": "integer",
"missed-acks-allowed": "integer",
"communication-lost-neighbor-disabled-hello": "integer",
"total-communication-lost": "integer",
"communication-lost-interface-down": "integer",
"neighbor-hello-state": "string",
"hello-interval": "integer",
"source-address-xr": "string",
"source-instance": "integer",
"hello-messages-received": "integer",
"hello-instance-owner": "string",
"up-time": {
"seconds": "string",
"nanoseconds": "string"
},
"communication-lost-wrong-destination-inst": "integer",
"hello-messages-sent": "integer"
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
COMMUNICATION-LOST-TIME - Retrieve
Retrieve operation of resource: communication-lost-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
GLOBAL-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: global-neighbor-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-detail": [
{
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"restart-timer-expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"missed-hellos": "integer",
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"is-restart-timer-running": "boolean",
"neighbor-hello-state": [
{
"entry": "string"
}
],
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer",
"restart-state": "string",
"hello-interval": "integer",
"lost-communication-total": [
{
"entry": "integer"
}
],
"is-gr-enabled": "boolean",
"interface-neighbor": [
{
"entry": "string"
}
],
"restart-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"recovery-time": "integer",
"node-address": "string",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
}
}
]
}
GLOBAL-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: global-neighbor-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"restart-timer-expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"missed-hellos": "integer",
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"is-restart-timer-running": "boolean",
"neighbor-hello-state": [
{
"entry": "string"
}
],
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer",
"restart-state": "string",
"hello-interval": "integer",
"lost-communication-total": [
{
"entry": "integer"
}
],
"is-gr-enabled": "boolean",
"interface-neighbor": [
{
"entry": "string"
}
],
"restart-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"recovery-time": "integer",
"node-address": "string",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
}
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
}
RESTART-TIME-LEFT - Retrieve
Retrieve operation of resource: restart-time-left
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
RESTART-TIMER-EXPIRY-TIME - Retrieve
Retrieve operation of resource: restart-timer-expiry-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
INTERFACE-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-neighbor
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
PSB-BRIEFS - Retrieve
Retrieve operation of resource: psb-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-brief": [
{
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"input-interface": "string",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
]
}
PSB-BRIEF - Retrieve
Retrieve operation of resource: psb-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"input-interface": "string",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
GLOBAL-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: global-neighbor-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-brief": [
{
"restart-state": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"lost-communication-total": [
{
"entry": "integer"
}
],
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"is-gr-enabled": "boolean",
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"node-address": "string",
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
]
}
GLOBAL-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: global-neighbor-brief
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"restart-state": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"lost-communication-total": [
{
"entry": "integer"
}
],
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"is-gr-enabled": "boolean",
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"node-address": "string",
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
RSVP - Retrieve
Retrieve operation of resource: rsvp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": {
"status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
},
"pxsb-details": {
"pxsb-detail": [
{
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
}
}
}
}
]
},
"global-neighbor-briefs": {
"global-neighbor-brief": [
{
"neighbor-address": "string",
"restart-state": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"lost-communication-total": [
{
"entry": "integer"
}
],
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"is-gr-enabled": "boolean",
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"node-address": "string",
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
]
}
}
ISSU - Retrieve
Retrieve operation of resource: issu
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
}
STATUS - Retrieve
Retrieve operation of resource: status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
BW-POOL-INFO - Retrieve
Retrieve operation of resource: bw-pool-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bc1-percent-configured": "boolean",
"max-res-pool-percent": "integer",
"is-bc0-percent-configured": "boolean",
"bc0-percent": "integer",
"bc1-percent": "integer",
"is-max-res-pool-percent-configured": "boolean",
"bandwidth-configuration-model": "string"
}
PXSB-DETAILS - Retrieve
Retrieve operation of resource: pxsb-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pxsb-detail": [
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"input-interface": "string",
"dynamic-state": "integer",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"hop": {
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
]
}
PXSB-DETAIL - Retrieve
Retrieve operation of resource: pxsb-detail
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"input-interface": "string",
"dynamic-state": "integer",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"hop": {
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
}
RSVP-HEADER - Retrieve
Retrieve operation of resource: rsvp-header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
}
RXSB-DETAILS - Retrieve
Retrieve operation of resource: rxsb-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rxsb-detail": [
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"dynamic-state": "integer",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"hop": {
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
]
}
RXSB-DETAIL - Retrieve
Retrieve operation of resource: rxsb-detail
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"dynamic-state": "integer",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"hop": {
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-type": "string"
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
}
RSVP-HEADER - Retrieve
Retrieve operation of resource: rsvp-header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
}
INTERFACE-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: interface-neighbor-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-brief": [
{
"interface-neighbor-list-compact": [
{
"neighbor-interface-name": "string",
"interface-neighbor-address": "string"
}
],
"node-address": "string"
}
]
}
INTERFACE-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: interface-neighbor-brief
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-list-compact": [
{
"neighbor-interface-name": "string",
"interface-neighbor-address": "string"
}
],
"node-address": "string"
}
INTERFACE-NEIGHBOR-LIST-COMPACT - Retrieve
Retrieve operation of resource: interface-neighbor-list-compact
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-interface-name": "string",
"interface-neighbor-address": "string"
}
CONTROLLER-SUMMARIES - Retrieve
Retrieve operation of resource: controller-summaries
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-summary": [
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
]
}
CONTROLLER-SUMMARY - Retrieve
Retrieve operation of resource: controller-summary
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
AUTHENTICATION-BRIEFS - Retrieve
Retrieve operation of resource: authentication-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-brief": [
{
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
}
]
}
AUTHENTICATION-BRIEF - Retrieve
Retrieve operation of resource: authentication-brief
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
}
SESSION-BRIEFS - Retrieve
Retrieve operation of resource: session-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-brief": [
{
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
}
]
}
SESSION-BRIEF - Retrieve
Retrieve operation of resource: session-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
PSB-DETAILEDS - Retrieve
Retrieve operation of resource: psb-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-detailed": [
{
"input-interface": "string",
"in-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"is-out-ero-valid": "boolean",
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"policy-source-info": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"out-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"backup-tunnel-name": "string",
"policy-query-flags": {
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
}
}
]
}
PSB-DETAILED - Retrieve
Retrieve operation of resource: psb-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"input-interface": "string",
"in-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"is-out-ero-valid": "boolean",
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"policy-source-info": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"out-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"backup-tunnel-name": "string",
"policy-query-flags": {
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
PATH-FLAGS - Retrieve
Retrieve operation of resource: path-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bidirectional": "boolean",
"is-lockout": "boolean",
"is-non-rsvp-hop-upstream": "boolean",
"is-message-id-valid": "boolean",
"is-local-sender": "boolean",
"is-local-repair": "boolean"
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
}
POLICY-SOURCE-INFO - Retrieve
Retrieve operation of resource: policy-source-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
CLASS-TYPE - Retrieve
Retrieve operation of resource: class-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-class-type-info-valid": "boolean",
"class-type": "integer"
}
PFC - Retrieve
Retrieve operation of resource: pfc
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": {
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
},
"output-interface": "string",
"policy-query-flags": {
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
IN-ERO - Retrieve
Retrieve operation of resource: in-ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
}
OUT-ERO - Retrieve
Retrieve operation of resource: out-ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
}
CONTROLLER-DETAILEDS - Retrieve
Retrieve operation of resource: controller-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-detailed": [
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
]
}
CONTROLLER-DETAILED - Retrieve
Retrieve operation of resource: controller-detailed
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-id": "string"
}
FRR-SUMMARY - Retrieve
Retrieve operation of resource: frr-summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-states": {
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
},
"path-states": {
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
}
}
PATH-STATES - Retrieve
Retrieve operation of resource: path-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
}
RESERVATION-STATES - Retrieve
Retrieve operation of resource: reservation-states
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
}
RSB-DETAILEDS - Retrieve
Retrieve operation of resource: rsb-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-detailed": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"label-info": {
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
},
"input-adjusted-interface": "string",
"filter": {}
}
]
}
RSB-DETAILED - Retrieve
Retrieve operation of resource: rsb-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"label-info": {
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
},
"input-adjusted-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {}
}
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-type": "string"
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
RSB-FLAGS - Retrieve
Retrieve operation of resource: rsb-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-lockout": "boolean",
"is-merge-point": "boolean",
"is-local-receiver": "boolean",
"is-message-id-valid": "boolean",
"is-local-repair": "boolean"
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
INTERFACE-SUMMARIES - Retrieve
Retrieve operation of resource: interface-summaries
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-summary": [
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
]
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
HELLO-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-instance-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-brief": [
{
"lost-communication-total": "integer",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"neighbor-hello-state": "string",
"instance-type": "string"
}
]
}
HELLO-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-instance-brief
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-total": "integer",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"neighbor-hello-state": "string",
"instance-type": "string"
}
AUTHENTICATION-DETAILS - Retrieve
Retrieve operation of resource: authentication-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-detail": [
{
"lifetime-left": "integer",
"challenge-status": "string",
"key-digest-info": "integer",
"key-status": "integer",
"auth-compact": {
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
},
"direction-info": {
"receive-info": {
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
},
"send-info": {
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
},
"auth-direction": "string"
},
"lifetime": "integer"
}
]
}
AUTHENTICATION-DETAIL - Retrieve
Retrieve operation of resource: authentication-detail
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lifetime-left": "integer",
"challenge-status": "string",
"key-digest-info": "integer",
"key-status": "integer",
"auth-compact": {
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
},
"direction-info": {
"receive-info": {
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
},
"send-info": {
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
},
"auth-direction": "string"
},
"lifetime": "integer"
}
AUTH-COMPACT - Retrieve
Retrieve operation of resource: auth-compact
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
}
DIRECTION-INFO - Retrieve
Retrieve operation of resource: direction-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"receive-info": {
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
},
"send-info": {
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
},
"auth-direction": "string"
}
SEND-INFO - Retrieve
Retrieve operation of resource: send-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
RECEIVE-INFO - Retrieve
Retrieve operation of resource: receive-info
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
SEQUENCE-WINDOW - Retrieve
Retrieve operation of resource: sequence-window
ID of source-address destination-address mode-id interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
RSB-BRIEFS - Retrieve
Retrieve operation of resource: rsb-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-brief": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
]
}
RSB-BRIEF - Retrieve
Retrieve operation of resource: rsb-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-type": "string"
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-messages": {
"interface-message": [
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
]
},
"message-summary": {
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer"
}
}
}
INTERFACE-MESSAGES - Retrieve
Retrieve operation of resource: interface-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-message": [
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
]
}
INTERFACE-MESSAGE - Retrieve
Retrieve operation of resource: interface-message
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
MESSAGE-SUMMARY - Retrieve
Retrieve operation of resource: message-summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
PREFIX-FILTERING - Retrieve
Retrieve operation of resource: prefix-filtering
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {
"interfaces": {
"interface": [
{
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
]
},
"summary": {
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
},
"accesses": {
"access": [
{
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer"
}
}
]
}
}
ACCESSES - Retrieve
Retrieve operation of resource: accesses
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"access": [
{
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
]
}
ACCESS - Retrieve
Retrieve operation of resource: access
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
TOTAL - Retrieve
Retrieve operation of resource: total
ID of access-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"dropped-path-messages": "integer"
}
]
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
TOTAL - Retrieve
Retrieve operation of resource: total
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"dropped-path-messages": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
TOTAL - Retrieve
Retrieve operation of resource: total
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
OUT-OF-RESOURCE - Retrieve
Retrieve operation of resource: out-of-resource
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {
"interfaces": {
"interface": [
{
"dropped-path-messages": "integer"
}
]
},
"summary": {
"dropped-path-messages": "integer"
}
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"dropped-path-messages": "integer"
}
]
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped-path-messages": "integer"
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"dropped-path-messages": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped-path-messages": "integer"
}
INTERFACE-EVENTS - Retrieve
Retrieve operation of resource: interface-events
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-event": [
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
]
}
INTERFACE-EVENT - Retrieve
Retrieve operation of resource: interface-event
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
NSR - Retrieve
Retrieve operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-id-ts": "integer",
"last-cleared-timestamp": "integer",
"total-states": "integer",
"last-idt-states": "integer",
"total-deletions": "integer",
"rsvp-process-role": "string",
"total-nacks": "integer"
}
ISSU - Retrieve
Retrieve operation of resource: issu
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total-id-ts": "integer",
"last-cleared-timestamp": "integer",
"total-states": "integer",
"last-idt-states": "integer",
"total-deletions": "integer",
"rsvp-process-role": "string",
"total-nacks": "integer"
}
DATABASE - Retrieve
Retrieve operation of resource: database
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"incoming-paths": "integer",
"sessions": "integer",
"interfaces": "integer",
"outgoing-paths": "integer",
"outgoing-reservations": "integer",
"incoming-reservations": "integer"
}
EVENT-SYNCS - Retrieve
Retrieve operation of resource: event-syncs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"event-sync": [
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
]
}
EVENT-SYNC - Retrieve
Retrieve operation of resource: event-sync
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
INTERFACE-DETAILEDS - Retrieve
Retrieve operation of resource: interface-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-detailed": [
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
]
}
INTERFACE-DETAILED - Retrieve
Retrieve operation of resource: interface-detailed
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-id": "string"
}
CONTROLLER-BRIEFS - Retrieve
Retrieve operation of resource: controller-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-brief": [
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
]
}
CONTROLLER-BRIEF - Retrieve
Retrieve operation of resource: controller-brief
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of controller-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"missed-hellos": "integer",
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-interval": "integer",
"global-neighbors": "integer",
"is-gr-enabled": "boolean",
"local-node-address": [
{
"local-node-ip-address": "string",
"application-type": "string"
}
],
"recovery-time": "integer",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
},
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer"
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-node-ip-address": "string",
"application-type": "string"
}
HELLO-INTERFACE-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-interface-instance-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-brief": [
{
"instance-type": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string"
}
]
}
HELLO-INTERFACE-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-interface-instance-brief
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"instance-type": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string"
}
HELLO-INTERFACE-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-interface-instance-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-detail": [
{
"last-message-sent-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-messages-received": "integer",
"hello-global-neighbor-id": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"destination-instance": "integer",
"instance-type": "string",
"source-instance": "integer",
"hello-messages-sent": "integer"
}
]
}
HELLO-INTERFACE-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-interface-instance-detail
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-message-sent-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-messages-received": "integer",
"hello-global-neighbor-id": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"destination-instance": "integer",
"instance-type": "string",
"source-instance": "integer",
"hello-messages-sent": "integer"
}
LAST-MESSAGE-SENT-TIME - Retrieve
Retrieve operation of resource: last-message-sent-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
INTERFACE-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: interface-neighbor-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-detail": [
{
"interface-neighbor-list-detail": [
{
"retransmitted-messages": "integer",
"neighbor-interface-name": "string",
"is-rr-enabled": "boolean",
"neighbor-epoch": "integer",
"interface-neighbor-address": "string",
"out-of-order-messages": "integer"
}
],
"node-address": "string"
}
]
}
INTERFACE-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-list-detail": [
{
"retransmitted-messages": "integer",
"neighbor-interface-name": "string",
"is-rr-enabled": "boolean",
"neighbor-epoch": "integer",
"interface-neighbor-address": "string",
"out-of-order-messages": "integer"
}
],
"node-address": "string"
}
INTERFACE-NEIGHBOR-LIST-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-list-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retransmitted-messages": "integer",
"neighbor-interface-name": "string",
"is-rr-enabled": "boolean",
"neighbor-epoch": "integer",
"interface-neighbor-address": "string",
"out-of-order-messages": "integer"
}
NSR - Retrieve
Retrieve operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
}
STATUS - Retrieve
Retrieve operation of resource: status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ls-ps": "integer",
"interfaces": "integer",
"issu-status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
},
"database-counters": {
"incoming-paths": "integer",
"sessions": "integer",
"interfaces": "integer",
"outgoing-paths": "integer",
"outgoing-reservations": "integer",
"incoming-reservations": "integer"
},
"nsr-status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
}
ISSU-STATUS - Retrieve
Retrieve operation of resource: issu-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
NSR-STATUS - Retrieve
Retrieve operation of resource: nsr-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
DATABASE-COUNTERS - Retrieve
Retrieve operation of resource: database-counters
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"incoming-paths": "integer",
"sessions": "integer",
"interfaces": "integer",
"outgoing-paths": "integer",
"outgoing-reservations": "integer",
"incoming-reservations": "integer"
}
FRRS - Retrieve
Retrieve operation of resource: frrs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frr": [
{
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"reservation-status": "string",
"path-status": "string"
}
]
}
FRR - Retrieve
Retrieve operation of resource: frr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"reservation-status": "string",
"path-status": "string"
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
REQUEST-BRIEFS - Retrieve
Retrieve operation of resource: request-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-brief": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"output-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
]
}
REQUEST-BRIEF - Retrieve
Retrieve operation of resource: request-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"output-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-type": "string"
}
REQUEST-DETAILS - Retrieve
Retrieve operation of resource: request-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-detail": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"psb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"rsb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"req-flags": {
"is-rro-in-path": "boolean",
"is-send-confirm": "boolean",
"is-merge-point": "boolean",
"is-refreshing": "boolean",
"is-ack-outstanding": "boolean",
"is-retransmit": "boolean",
"is-label-request-in-path": "boolean",
"is-nack-received": "boolean",
"is-record-label-in-path": "boolean",
"is-message-id-allocated": "boolean",
"is-paced": "boolean",
"is-local-receiver": "boolean"
},
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {}
}
}
}
]
}
REQUEST-DETAIL - Retrieve
Retrieve operation of resource: request-detail
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"psb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"rsb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"req-flags": {
"is-rro-in-path": "boolean",
"is-send-confirm": "boolean",
"is-merge-point": "boolean",
"is-refreshing": "boolean",
"is-ack-outstanding": "boolean",
"is-retransmit": "boolean",
"is-label-request-in-path": "boolean",
"is-nack-received": "boolean",
"is-record-label-in-path": "boolean",
"is-message-id-allocated": "boolean",
"is-paced": "boolean",
"is-local-receiver": "boolean"
},
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
}
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
FILTER - Retrieve
Retrieve operation of resource: filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
STYLE - Retrieve
Retrieve operation of resource: style
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-type": "string"
}
REQ-FLAGS - Retrieve
Retrieve operation of resource: req-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-rro-in-path": "boolean",
"is-send-confirm": "boolean",
"is-merge-point": "boolean",
"is-refreshing": "boolean",
"is-ack-outstanding": "boolean",
"is-retransmit": "boolean",
"is-label-request-in-path": "boolean",
"is-nack-received": "boolean",
"is-record-label-in-path": "boolean",
"is-message-id-allocated": "boolean",
"is-paced": "boolean",
"is-local-receiver": "boolean"
}
HOP - Retrieve
Retrieve operation of resource: hop
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
}
HEADER - Retrieve
Retrieve operation of resource: header
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
PSB-KEY - Retrieve
Retrieve operation of resource: psb-key
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
RSB-KEY - Retrieve
Retrieve operation of resource: rsb-key
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
INTERFACE-BRIEFS - Retrieve
Retrieve operation of resource: interface-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-brief": [
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
]
}
INTERFACE-BRIEF - Retrieve
Retrieve operation of resource: interface-brief
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
SESSION-DETAILEDS - Retrieve
Retrieve operation of resource: session-detaileds
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-detailed": [
{
"compact": {
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"psb-rsb-info": [
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
}
]
}
]
}
]
}
SESSION-DETAILED - Retrieve
Retrieve operation of resource: session-detailed
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"compact": {
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"psb-rsb-info": [
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer"
}
}
}
]
}
]
}
COMPACT - Retrieve
Retrieve operation of resource: compact
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
PSB-RSB-INFO - Retrieve
Retrieve operation of resource: psb-rsb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"p2mp-sub-group-origin": "string",
"reverse-lsp": {
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
]
}
}
]
}
PSB-INFO - Retrieve
Retrieve operation of resource: psb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"p2mp-sub-group-origin": "string",
"reverse-lsp": {
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"unsup-sub-object": [
{}
]
}
}
GENERIC-IN-LABEL - Retrieve
Retrieve operation of resource: generic-in-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
ASSOCIATION - Retrieve
Retrieve operation of resource: association
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-ipv4": {
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
},
"extended-ipv6": {
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
},
"ipv4": {
"source": "string",
"type": "integer",
"id": "integer"
},
"association-type": "string",
"ipv6": {
"source": "string",
"type": "integer",
"id": "integer"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": "string",
"type": "integer",
"id": "integer"
}
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": "string",
"type": "integer",
"id": "integer"
}
EXTENDED-IPV4 - Retrieve
Retrieve operation of resource: extended-ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
EXTENDED-IPV6 - Retrieve
Retrieve operation of resource: extended-ipv6
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
PROTECTION - Retrieve
Retrieve operation of resource: protection
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-flags": {
"reserved-bit2": "boolean",
"reserved-bit1": "boolean",
"unprotected": "boolean",
"ded1-plus1": "boolean",
"enhanced": "boolean",
"shared": "boolean",
"extra-traffic": "boolean",
"ded1-to1": "boolean"
},
"s": "boolean",
"o": "boolean",
"n": "boolean",
"p": "boolean",
"lsp-flags": {
"rerouting-no-et": "boolean",
"one-plus-one-uni": "boolean",
"one-plus-one-bi": "boolean",
"rerouting": "boolean",
"one-to-n-protection-et": "boolean"
}
}
LSP-FLAGS - Retrieve
Retrieve operation of resource: lsp-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rerouting-no-et": "boolean",
"one-plus-one-uni": "boolean",
"one-plus-one-bi": "boolean",
"rerouting": "boolean",
"one-to-n-protection-et": "boolean"
}
LINK-FLAGS - Retrieve
Retrieve operation of resource: link-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reserved-bit2": "boolean",
"reserved-bit1": "boolean",
"unprotected": "boolean",
"ded1-plus1": "boolean",
"enhanced": "boolean",
"shared": "boolean",
"extra-traffic": "boolean",
"ded1-to1": "boolean"
}
REVERSE-LSP - Retrieve
Retrieve operation of resource: reverse-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"unsup-sub-object": [
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{
"entry": "integer"
}
]
}
]
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
ERO - Retrieve
Retrieve operation of resource: ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
}
UNSUP-SUB-OBJECT - Retrieve
Retrieve operation of resource: unsup-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{
"entry": "integer"
}
]
}
RSVP-MGMT-REV-LSP-UNSUPPORTED-SUBOBJ - Retrieve
Retrieve operation of resource: rsvp-mgmt-rev-lsp-unsupported-subobj
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
ERO - Retrieve
Retrieve operation of resource: ero
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
}
RRO - Retrieve
Retrieve operation of resource: rro
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-global-label": "boolean"
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srl-gs": [
{
"entry": "integer"
}
]
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
RSB-INFO - Retrieve
Retrieve operation of resource: rsb-info
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-out-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"out-interface": "string",
"is-valid": "boolean",
"is-flow-spec-valid": "boolean",
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-rro-valid": "boolean",
"destination-address": "string",
"backup-label": "string",
"out-label": "string",
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
},
"backup-interface": "string"
}
GENERIC-OUT-LABEL - Retrieve
Retrieve operation of resource: generic-out-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": [
{
"entry": "integer"
}
]
}
VALUE - Retrieve
Retrieve operation of resource: value
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
RRO - Retrieve
Retrieve operation of resource: rro
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-global-label": "boolean"
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
FLAGS - Retrieve
Retrieve operation of resource: flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srl-gs": [
{
"entry": "integer"
}
]
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
HELLO-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-instance-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-detail": [
{
"communication-lost-wrong-source-inst": "integer",
"communication-lost-reason": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"destination-instance": "integer",
"instance-type": "string",
"communication-lost-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-request-suppressed": "integer",
"communication-lost-hello-missed": "integer",
"missed-acks-allowed": "integer",
"communication-lost-neighbor-disabled-hello": "integer",
"total-communication-lost": "integer",
"communication-lost-interface-down": "integer",
"neighbor-hello-state": "string",
"hello-interval": "integer",
"source-address-xr": "string",
"source-instance": "integer",
"hello-messages-received": "integer",
"hello-instance-owner": "string",
"up-time": {
"seconds": "string",
"nanoseconds": "string"
},
"communication-lost-wrong-destination-inst": "integer",
"hello-messages-sent": "integer"
}
]
}
HELLO-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-instance-detail
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"communication-lost-wrong-source-inst": "integer",
"communication-lost-reason": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"destination-instance": "integer",
"instance-type": "string",
"communication-lost-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-request-suppressed": "integer",
"communication-lost-hello-missed": "integer",
"missed-acks-allowed": "integer",
"communication-lost-neighbor-disabled-hello": "integer",
"total-communication-lost": "integer",
"communication-lost-interface-down": "integer",
"neighbor-hello-state": "string",
"hello-interval": "integer",
"source-address-xr": "string",
"source-instance": "integer",
"hello-messages-received": "integer",
"hello-instance-owner": "string",
"up-time": {
"seconds": "string",
"nanoseconds": "string"
},
"communication-lost-wrong-destination-inst": "integer",
"hello-messages-sent": "integer"
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
COMMUNICATION-LOST-TIME - Retrieve
Retrieve operation of resource: communication-lost-time
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
GLOBAL-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: global-neighbor-details
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-detail": [
{
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"restart-timer-expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"missed-hellos": "integer",
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"is-restart-timer-running": "boolean",
"neighbor-hello-state": [
{
"entry": "string"
}
],
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer",
"restart-state": "string",
"hello-interval": "integer",
"lost-communication-total": [
{
"entry": "integer"
}
],
"is-gr-enabled": "boolean",
"interface-neighbor": [
{
"entry": "string"
}
],
"restart-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"recovery-time": "integer",
"node-address": "string",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
}
}
]
}
GLOBAL-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: global-neighbor-detail
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"restart-timer-expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"missed-hellos": "integer",
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"is-restart-timer-running": "boolean",
"neighbor-hello-state": [
{
"entry": "string"
}
],
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer",
"restart-state": "string",
"hello-interval": "integer",
"lost-communication-total": [
{
"entry": "integer"
}
],
"is-gr-enabled": "boolean",
"interface-neighbor": [
{
"entry": "string"
}
],
"restart-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"recovery-time": "integer",
"node-address": "string",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
}
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
}
RESTART-TIME-LEFT - Retrieve
Retrieve operation of resource: restart-time-left
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
RESTART-TIMER-EXPIRY-TIME - Retrieve
Retrieve operation of resource: restart-timer-expiry-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
INTERFACE-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-neighbor
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
PSB-BRIEFS - Retrieve
Retrieve operation of resource: psb-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-brief": [
{
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"input-interface": "string",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
]
}
PSB-BRIEF - Retrieve
Retrieve operation of resource: psb-brief
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"input-interface": "string",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-destination-address": "string"
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"source-address": "string"
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
GLOBAL-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: global-neighbor-briefs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-brief": [
{
"restart-state": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"lost-communication-total": [
{
"entry": "integer"
}
],
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"is-gr-enabled": "boolean",
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"node-address": "string",
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
]
}
GLOBAL-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: global-neighbor-brief
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"restart-state": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"lost-communication-total": [
{
"entry": "integer"
}
],
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"is-gr-enabled": "boolean",
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"node-address": "string",
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"seconds": "string",
"nanoseconds": "string"
}
Schema Definitions
RSVP-MGMT-IF-NBR-DETAIL:
Detail Info for RSVP Interface Neighbor
- retransmitted-messages: integer
-
Number of retransmitted msgs
- neighbor-interface-name: string
-
Neighbor's Interface handle
- is-rr-enabled: boolean
-
Is Neighbor's RR enable
- neighbor-epoch: integer
-
Neighbor's epoch value
- interface-neighbor-address: string
-
Interface Neighbor address
- out-of-order-messages: integer
-
Number of out of order msgs
Example
{
"retransmitted-messages": "integer",
"neighbor-interface-name": "string",
"is-rr-enabled": "boolean",
"neighbor-epoch": "integer",
"interface-neighbor-address": "string",
"out-of-order-messages": "integer"
}
RSVP-MGMT-FILTER-P2MP-IPV4:
RSVP P2MP IPv4 FilterSpec
- source-port: integer
-
Source Port
- p2mp-sub-group-origin: string
-
Point to Multipoint SubGroup Origin
- sub-group-id: integer
-
Point to Multipoint Subgroup ID
- source-address: string
-
Source Address
Example
{
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
}
RSVP-FILTER-UNION:
Union of the different RSVP filterspec types
- udp-ipv4-session: RSVP-MGMT-FILTER-IPV4
-
UDP IPV4 FilterSpec
- p2mp-ipv4-session: RSVP-MGMT-FILTER-P2MP-IPV4
-
IPv4 P2MP LSP FilterSpec
- filter-type: string rsvp-mgmt-filter-type-ipv4, rsvp-mgmt-filter-type-p2mp-lsp-ipv4
-
FilterType
Example
{
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
RSVP-MGMT-RRO-IPV4-SUBOBJ-FLAGS:
RSVP RRO IPV4 Subobject Flags
- is-node-protection-available: boolean
-
Node Protection Available
- is-protection-in-use: boolean
-
Local Protection In Use
- is-node-id: boolean
-
Node ID In Use
- is-protection-available: boolean
-
Local Protection Available
- is-bandwidth-protected: boolean
-
Bandwidth Protection Available
Example
{
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
}
RSVP-MGMT-POLICY-QUERY-FLAGS:
RSVP Policy Query Flags
- is-bypass: boolean
-
Bypass
- is-report-required: boolean
-
Report Required
- is-resync: boolean
-
Resynchronization
- is-needed: boolean
-
Needed
Example
{
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
RSVP-MGMT-AUTH-DIRECTION-SEND:
RSVP Authentication Send Type Information
- sequence: integer
-
Sequence number
- counters: RSVP-MGMT-AUTH-SEND-TYPE-COUNTERS
-
Counters
Example
{
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
}
RSVP-MGMT-DSTE-MODE-INTERFACE-BW:
Union of the different RSVP interface bandwidth types
- dste-mode: string pre-standard, standard
-
DSTEMode
- standard-dste-interface: RSVP-MGMT-INTERFACE-BW-STD-DSTE
-
Standard DSTE interface information
- pre-standard-dste-interface: RSVP-MGMT-INTERFACE-BW-PRESTD-DSTE
-
Prestandard DSTE interface information
Example
{
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
}
RSVP-MGMT-REVERSE-LSP:
RSVP REVERSE_LSP Object
- generic-traffic-spec: RSVP-MGMT-GEN-TRAFFIC-SPEC
-
Generic Traffic Spec object
- ero: RSVP-MGMT-ERO-SUBOBJ
-
Explicit Route Sub Objects
-
RSVP-MGMT-ERO-SUBOBJ - unsup-sub-object: RSVP-MGMT-REV-LSP-UNSUPPORTED-SUBOBJ
-
Unsupported REVERSE_LSP Sub Objects
-
RSVP-MGMT-REV-LSP-UNSUPPORTED-SUBOBJ
Example
{
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"unsup-sub-object": [
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{
"entry": "integer"
}
]
}
]
}
RSVP-MGMT-AUTH-RECV-TYPE-COUNTERS:
RSVP Authentication Receive Type Counters
- authentication-received-no-integrity: integer
-
Authentication received with no integrity
- authentication-received-incomplete: integer
-
Authentication received incomplete
- authentication-received-valid-messages: integer
-
Valid messages
- authentication-received-sequence-number-duplicate: integer
-
Authentication received with duplicate sequence number
- authentication-received-sequence-number-outof-range: integer
-
Authentication received with sequence number out of range
- authentication-received-challenge-timeouts: integer
-
Challenge timeouts
- authentication-received-challenges-response-duplicate: integer
-
Duplicate challenge responses received
- authentication-received-challenges-resent: integer
-
Challenges resent
- authentication-received-challenge-response: integer
-
Challenge responses received
- authentication-received-response-late: integer
-
Challenge responses received late
- authentication-received-challenges-sent: integer
-
Challenges sent
- authentication-received-bad-digest: integer
-
Authentication received with bad digest
- authentication-received-during-challenge: integer
-
Authentication received during challenge
- authentication-received-wrong-challenges-response: integer
-
Incorect challenge responses received
- authentication-received-bad-message-format: integer
-
Authentication received with bad mesage format
- authentication-received-wrong-digest-type: integer
-
Authentication received with wrong digest type
Example
{
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
RSVP-MGMT-STYLE:
RSVP Reservation Style
- reservation-type: string rsvp-mgmt-ff-option, rsvp-mgmt-wf-option, rsvp-mgmt-se-option
-
The Reservation Type: WF, SE or FF
Example
{
"reservation-type": "string"
}
RSVP-MGMT-RRO-UNNUMBERED-SUBOBJ:
RSVP RRO Unnumbered subobject
- interface-id: integer
-
The RRO Interface ID
- flags: RSVP-MGMT-RRO-UNNUMBERED-SUBOBJ-FLAGS
-
The RRO Subobject Unnumbered Flags
- interface-address: string
-
The RRO Interface Address
Example
{
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
AUTHENTICATION-DETAIL-TABLE:
Common node of rsvp, rsvp-standby
- authentication-details: object
-
Table for detailed authentication related information
-
- authentication-detail: object[]
-
Brief Authentication information
-
- mode-id: string send, receive
-
Mode (Tx or Rx)
- destination-address: string
-
Destination Address
- interface-name: string
-
InterfaceName
- source-address: string
-
Source Address
Example
{
"authentication-details": {
"authentication-detail": [
{
"mode-id": "string",
"destination-address": "string",
"interface-name": "string",
"source-address": "string",
"lifetime-left": "integer",
"challenge-status": "string",
"key-digest-info": "integer",
"key-status": "integer",
"auth-compact": {
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
},
"direction-info": {
"receive-info": {
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
},
"send-info": {
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
},
"auth-direction": "string"
},
"lifetime": "integer"
}
]
}
}
RSVP-SYNC-COUNT-INFO:
RSVP sync sent and received counters information
- total-id-ts: integer
-
Total number of IDTs
- last-cleared-timestamp: integer
-
The timestamp, in seconds, when these statistics are cleared since 00:00:00 UTC, January 1, 1970
- total-states: integer
-
Total number of states
- last-idt-states: integer
-
Last IDT number of states
- total-deletions: integer
-
Total number of deletions
- rsvp-process-role: string unknown, v1-active, v1-standby, v2-active, v2-standby, v1-active-post-big-bang, v1-standby-post-big-bang, count
-
Process role
- total-nacks: integer
-
Total number of NACKs
Example
{
"total-id-ts": "integer",
"last-cleared-timestamp": "integer",
"total-states": "integer",
"last-idt-states": "integer",
"total-deletions": "integer",
"rsvp-process-role": "string",
"total-nacks": "integer"
}
RSVP-MGMT-GRACEFUL-RESTART:
RSVP Graceful Restart Info
- missed-hellos: integer
-
Max number of hellos missed before hellos declared down
- recovery-time-left: RSVP-MGMT-TIMESPEC
-
How much recovery timer remains
- hello-interval: integer
-
Interval at which hello messages are sent
- global-neighbors: integer
-
Global neighbor count
- is-gr-enabled: boolean
-
Whether GR is enabled
- local-node-address: RSVP-MGMT-LOCAL-NODE-ID-IPV4
-
Local node address
-
RSVP-MGMT-LOCAL-NODE-ID-IPV4 - recovery-time: integer
-
Recovery time (milliseconds)
- recovery-timer-exp-time: RSVP-MGMT-TIMESPEC
-
Time at which recovery timer will expire
- pending-states: integer
-
Total number of pending states
- is-recovery-timer-running: boolean
-
Whether recovery timer is running
- restart-time: integer
-
Restart time (milliseconds)
Example
{
"missed-hellos": "integer",
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-interval": "integer",
"global-neighbors": "integer",
"is-gr-enabled": "boolean",
"local-node-address": [
{
"local-node-ip-address": "string",
"application-type": "string"
}
],
"recovery-time": "integer",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
},
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer"
}
RSVP-SESSION-UNION:
Union of the different RSVP session types
- ipv4-lsp-session: RSVP-MGMT-SESSION-LSP-TUNNEL-IPV4
-
IPv4 LSP session
- ipv4-uni-session: RSVP-MGMT-SESSION-UNI-IPV4
-
IPv4 UNI session
- session-type: string rsvp-mgmt-session-type-udp-ipv4, rsvp-mgmt-session-type-lsp-ipv4, rsvp-mgmt-session-type-uni-ipv4, rsvp-mgmt-session-type-p2mp-lsp-ipv4
-
SessionType
- ipv4: RSVP-MGMT-SESSION-UDP-IPV4
-
UDP IPv4 session
- ipv4-p2mp-lsp-session: RSVP-MGMT-SESSION-P2MP-LSP-TUNNEL-IPV4
-
IPv4 P2MP LSP session
Example
{
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
RSVP-MGMT-EVENT-COUNT-INFO:
Count of events
- nac-ks: integer
-
Counter for NACKs received
- expired-paths: integer
-
Counter for Expired Path states
- expired-reservations: integer
-
Counter for Expired Reservation states
Example
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
RSVP-MGMT-RRO-SRLG-SUBOBJ:
RSVP RRO SRLG subobject
- srl-gs: object[]
-
The RRO Subobject SRLGs
-
object - entry: integer
-
The RRO Subobject SRLGs
Example
{
"srl-gs": [
{
"entry": "integer"
}
]
}
RSVP-MGMT-ALL-DB-COUNTERS:
All database counters
- incoming-paths: integer
-
Number of locally created and incoming path states
- sessions: integer
-
Number of sessions
- interfaces: integer
-
Number of Interfaces
- outgoing-paths: integer
-
Number of outgoing path states
- outgoing-reservations: integer
-
Number of outgoing reservation states
- incoming-reservations: integer
-
Number of locally created and incoming reservation states
Example
{
"incoming-paths": "integer",
"sessions": "integer",
"interfaces": "integer",
"outgoing-paths": "integer",
"outgoing-reservations": "integer",
"incoming-reservations": "integer"
}
RSVP-MGMT-AUTHENTICATION-COMPACT:
Authentication Compact Information
- neighbor-address: string
-
Neighbor address
- direction: string rsvp-mgmt-auth-direction-send, rsvp-mgmt-auth-direction-recv
-
Direction
- key-source: string
-
Key source
- key-type: string rsvp-mgmt-auth-ki-type-none, rsvp-mgmt-auth-ki-type-global, rsvp-mgmt-auth-ki-type-interface, rsvp-mgmt-auth-ki-type-neighbor
-
Key type
- key-id-valid: integer
-
Key validity
- destination-address-xr: string
-
Destination address
- source-address-xr: string
-
Source address
- key-id: integer
-
Key ID
Example
{
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
}
RSVP-MGMT-INTERFACE-COMPACT:
Compact Form of RSVP interface Info
- bandwidth-information: RSVP-MGMT-DSTE-MODE-INTERFACE-BW
-
Interface bandwidth information
- interface-name-xr: string
-
Interface Name
Example
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
RSVP-MGMT-GLBL-NBR-FLAGS:
Global Neighbor Flags
- is-application-mpls: boolean
-
MPLS Application
- is-application-ouni: boolean
-
OUNI Application
Example
{
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
}
RSVP-MGMT-POLICY-SOURCES:
RSVP Policy Sources
- is-local: boolean
-
Policy Source is Local
- is-cops: boolean
-
Policy Source is COPS
- is-cable: boolean
-
Policy Source is Cable
- is-default: boolean
-
Policy Source is Default
- is-te-link: boolean
-
Policy Source is TE Link
Example
{
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
}
RSVP-MGMT-NBOR:
Neighbor
- neighbor-address: string
-
IP address of the neighbor
- outgoing-states: string
-
Number of outgoing states to the neighbour
- expiry-time: RSVP-MGMT-TIMESPEC
-
Expiry time
- message-ids: integer
-
Number of MessageIDs
- neighbor-message-id: RSVP-MGMT-MESSAGEID
-
List of Neighbor MessageIDs
-
RSVP-MGMT-MESSAGEID - is-neighbor-refresh-reduction-capable: boolean
-
Is neighbor capable of Refresh Reduction
Example
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
RSVP-MGMT-REQUEST-COMPACT:
Compact Form of RSVP Request Info
- flow-spec: RSVP-MGMT-FLOW-SPEC
-
Flow Spec Information
- style: RSVP-MGMT-STYLE
-
RSVP Style
- output-interface: string
-
Output Interface
- filter: RSVP-MGMT-FILTER-INFO
-
RSVP Filter
- s2l-sub-lsp: RSVP-MGMT-S2L-SUB-LSP-IPV4
-
RSVP S2L Sub-LSP information
- session: RSVP-MGMT-SESSION-INFO
-
RSVP Session Information
- generic-flow-spec: RSVP-MGMT-GEN-FLOW-SPEC
-
Generic Flow Spec Information
Example
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"output-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
RSVP-MGMT-COUNT-PREFIX-MSG:
Message types for prefix filtering
- total: integer
-
Total count of messages
- path: integer
-
Count of Path messages
- reservation-confirm: integer
-
Count of ReservationConfirm messages
- path-tear: integer
-
Count of PathTear messages
Example
{
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
RSVP-GLOBAL-INFO:
RSVP global information
- ls-ps: integer
-
Total LSPs
- interfaces: integer
-
Total interfaces
- issu-status: RSVP-NSR-ISSU-STATUS-INFO
-
Issu status
- database-counters: RSVP-MGMT-ALL-DB-COUNTERS
-
All database counters
- nsr-status: RSVP-NSR-ISSU-STATUS-INFO
-
NSR status
Example
{
"ls-ps": "integer",
"interfaces": "integer",
"issu-status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
},
"database-counters": {
"incoming-paths": "integer",
"sessions": "integer",
"interfaces": "integer",
"outgoing-paths": "integer",
"outgoing-reservations": "integer",
"incoming-reservations": "integer"
},
"nsr-status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
}
RSVP-MGMT-HOP-INFO:
Hop Info
- neighbor-address: string
-
IP address of the neighbor
- neighbor-logical-interface-name: string
-
Neighbor Logical Interface Name
Example
{
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
}
RSB-DETAILED-TABLE:
Common node of rsvp, rsvp-standby
- rsb-detaileds: object
-
Table of detailed info about reservation state blocks
-
- rsb-detailed: object[]
-
Detailed info for a single reservation state block
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"rsb-detaileds": {
"rsb-detailed": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"label-info": {
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
},
"input-adjusted-interface": "string",
"filter": {}
}
]
}
}
RSVP-MGMT-SESSION-INFO:
RSVP Session Info
- rsvp-session: RSVP-SESSION-UNION
-
RSVP Session
Example
{
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
}
RSVP-MGMT-COUNTS:
Counters for all known RSVP message types
- ack: integer
-
Count of ACK messages
- challenge: integer
-
Count of Integrity Challenge messages
- reservation-confirm: integer
-
Count of ReservationConfirm messages
- bundle: integer
-
Count of Bundle messages
- response: integer
-
Count of Integrity Response messages
- srefresh: integer
-
Count of Srefresh messages
- path-error: integer
-
Count of PathError messages
- reservation-error: integer
-
Count of ReservationError messages
- reservation: integer
-
Count of Reservation messages
- path: integer
-
Count of Path messages
- path-tear: integer
-
Count of PathTear messages
- hello: integer
-
Count of Hello messages
- reservation-tear: integer
-
Count of ReservationTear messages
Example
{
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
}
RSVP-MGMT-RRO-UNNUMBERED-SUBOBJ-FLAGS:
RSVP RRO UNNUMBERED Subobject Flags
- is-node-protection-available: boolean
-
Node Protection Available
- is-protection-in-use: boolean
-
Local Protection In Use
- is-node-id: boolean
-
Node ID In Use
- is-protection-available: boolean
-
Local Protection Available
- is-bandwidth-protected: boolean
-
Bandwidth Protection Available
Example
{
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
}
INTERFACE-NEIGHBOR-DETAIL-TABLE:
Common node of rsvp, rsvp-standby
- interface-neighbor-details: object
-
Table of detailed info about I/F neighbors
-
- interface-neighbor-detail: object[]
-
Detailed info for a single interface neighbor
-
- neighbor-address: string
-
Address of global neighbor
Example
{
"interface-neighbor-details": {
"interface-neighbor-detail": [
{
"neighbor-address": "string",
"interface-neighbor-list-detail": [
{
"retransmitted-messages": "integer",
"neighbor-interface-name": "string",
"is-rr-enabled": "boolean",
"neighbor-epoch": "integer",
"interface-neighbor-address": "string",
"out-of-order-messages": "integer"
}
],
"node-address": "string"
}
]
}
}
SESSION-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- session-briefs: object
-
Table of brief info about sessions
-
- session-brief: object[]
-
Brief info about session
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- extended-tunnel-id: string
-
Extended Tunnel ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
Example
{
"session-briefs": {
"session-brief": [
{
"destination-port": "integer",
"protocol": "integer",
"extended-tunnel-id": "string",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
}
]
}
}
RSVP-MGMT-INTERFACE-SUMMARY:
Summary Form of RSVP interface Info
- reservations-in: integer
-
Number of locally created and incoming reservation states
- reservations-out: integer
-
Number of outgoing reservation states
- bandwidth-information: RSVP-MGMT-DSTE-MODE-INTERFACE-BW
-
Interface bandwidth information
- paths-out: integer
-
Number of outgoing path states
- interface-name-xr: string
-
Interface Name
- paths-in: integer
-
Number of locally created and incoming path states
Example
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
RSVP-MGMT-LOCAL-NODE-ID-IPV4:
Local Node-id
- local-node-ip-address: string
-
Local node address
- application-type: string ouni, gmpls
-
GR local node-id app type
Example
{
"local-node-ip-address": "string",
"application-type": "string"
}
RSVP-MGMT-SESSION-P2MP-LSP-TUNNEL-IPV4:
RSVP P2MP-LSP-Tunnel-IPv4 Session
- tunnel-id: integer
-
The Session Tunnel ID
- p2mp-id: integer
-
The Point to Multipoint ID
- extended-tunnel-id: string
-
The Session Extended Tunnel ID
Example
{
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
HELLO-INTERFACE-INSTANCE-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- hello-interface-instance-briefs: object
-
Table of brief info about i/f-based hello instances
-
- hello-interface-instance-brief: object[]
-
Brief info for a single interface-based hello instance
-
- destination-address: string
-
Destination Address
- source-address: string
-
Source Address
Example
{
"hello-interface-instance-briefs": {
"hello-interface-instance-brief": [
{
"destination-address": "string",
"source-address": "string",
"instance-type": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string"
}
]
}
}
RSVP-MGMT-HELLO-INSTANCE-DETAIL:
Detail Info for RSVP Hello Instance
- communication-lost-wrong-source-inst: integer
-
Count of lost comm. due to wrong Source Inst
- communication-lost-reason: string not-applicable, wrong-destination-instance, wrong-source-instance, hello-missed, interface-down, neighbor-disabled-hello, control-channel-down
-
Reason why communication was lost
- destination-address-xr: string
-
Destination address
- hello-interface: string
-
Interface to use
- destination-instance: integer
-
Destination Instance
- instance-type: string active, passive
-
Hello instance type
- communication-lost-time: RSVP-MGMT-TIMESPEC
-
Time when communication was lost
- hello-request-suppressed: integer
-
Count of Hello Requests suppessed
- communication-lost-hello-missed: integer
-
Lost Comm. Hello missed count
- missed-acks-allowed: integer
-
Number of missed Hello allowed
- communication-lost-neighbor-disabled-hello: integer
-
Count of lost comm. due to nbor disabling Hellos
- total-communication-lost: integer
-
Total number of times communication got lost
- communication-lost-interface-down: integer
-
Count of lost comm. due to interface down
- neighbor-hello-state: string hello-state-init, hello-state-up, hello-state-down
-
Neighbor Hello state
- hello-interval: integer
-
Hello Interval
- source-address-xr: string
-
Source address
- source-instance: integer
-
Source Instance
- hello-messages-received: integer
-
Number of hello messages received
- hello-instance-owner: string mpls-graceful-restart, mpls-ouni
-
Hello instance owner
- up-time: RSVP-MGMT-TIMESPEC
-
Hello up time
- communication-lost-wrong-destination-inst: integer
-
Count of lost comm. due to wrong Destination Inst
- hello-messages-sent: integer
-
Number of hello messages sent
Example
{
"communication-lost-wrong-source-inst": "integer",
"communication-lost-reason": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"destination-instance": "integer",
"instance-type": "string",
"communication-lost-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-request-suppressed": "integer",
"communication-lost-hello-missed": "integer",
"missed-acks-allowed": "integer",
"communication-lost-neighbor-disabled-hello": "integer",
"total-communication-lost": "integer",
"communication-lost-interface-down": "integer",
"neighbor-hello-state": "string",
"hello-interval": "integer",
"source-address-xr": "string",
"source-instance": "integer",
"hello-messages-received": "integer",
"hello-instance-owner": "string",
"up-time": {
"seconds": "string",
"nanoseconds": "string"
},
"communication-lost-wrong-destination-inst": "integer",
"hello-messages-sent": "integer"
}
RSVP-MGMT-SESSION-DETAIL:
RSVP Detail Session Info
- compact: RSVP-MGMT-SESSION-COMPACT
-
Compact session data
- s2l-sub-lsp: RSVP-MGMT-S2L-SUB-LSP-IPV4
-
RSVP S2L Sub-LSP information
- psb-rsb-info: RSVP-SESSION-PSB-RSB-DETAIL
-
Path and Reservation Info
-
RSVP-SESSION-PSB-RSB-DETAIL
Example
{
"compact": {
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"psb-rsb-info": [
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer"
}
}
}
]
}
]
}
RSVP-MGMT-HELLO-INSTANCE-COMPACT:
Compact Info for RSVP Hello Instance
- lost-communication-total: integer
-
Total number of times communication got lost
- destination-address-xr: string
-
Destination address
- hello-interface: string
-
Interface to use
- source-address-xr: string
-
Source address
- neighbor-hello-state: string hello-state-init, hello-state-up, hello-state-down
-
Neighbor Hello state
- instance-type: string active, passive
-
Hello instance type
Example
{
"lost-communication-total": "integer",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"neighbor-hello-state": "string",
"instance-type": "string"
}
PSB-DETAILED-TABLE:
Common node of rsvp, rsvp-standby
- psb-detaileds: object
-
Table of detailed info about path state blocks
-
- psb-detailed: object[]
-
Detailed info for a single path state block
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"psb-detaileds": {
"psb-detailed": [
{
"input-interface": "string",
"in-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"is-out-ero-valid": "boolean",
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"policy-source-info": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"out-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"backup-tunnel-name": "string",
"policy-query-flags": {
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
},
"expiry-time": {
"seconds": "string"
}
}
]
}
}
RSVP-MGMT-FILTER-INFO:
RSVP FilterSpec Info
- rsvp-filter: RSVP-FILTER-UNION
-
RSVP Filter
Example
{
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
}
RSVP-MGMT-FLOW-SPEC:
RSVP Flow Spec
- flow-peak-rate: integer
-
The Flow Peak Rate in bytes per second
- flow-max-unit: integer
-
The Flow Maximum Unit
- flow-max-burst: integer
-
The Flow Maximum Burst
- flow-requested-rate: integer
-
The Flow Requested Rate in bytes per second
- flow-average-rate: integer
-
The Flow Average Rate in bytes per second
- flow-qos: string rsvp-mgmt-qos-unknown, rsvp-mgmt-qos-guaranteed, rsvp-mgmt-qos-controlled-load, rsvp-mgmt-qos-qualitative
-
The Flow Quality of Service
- flow-slack: integer
-
The Flow Slack
- flow-min-unit: integer
-
The Flow Minimum Unit
Example
{
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
}
RSVP-MGMT-RSB-FLAGS:
Reservation State Block Flags
- is-lockout: boolean
-
Locked Out
- is-merge-point: boolean
-
Is node a Merge Point
- is-local-receiver: boolean
-
Local Receiver
- is-message-id-valid: boolean
-
MessageID Valid
- is-local-repair: boolean
-
Rerouted
Example
{
"is-lockout": "boolean",
"is-merge-point": "boolean",
"is-local-receiver": "boolean",
"is-message-id-valid": "boolean",
"is-local-repair": "boolean"
}
RSVP-MGMT-AUTHENTICATION-DETAIL:
Authentication Detail Information
- lifetime-left: integer
-
Remaining lifetime (seconds)
- challenge-status: string rsvp-mgmt-auth-cs-not-cfg, rsvp-mgmt-auth-cs-completed, rsvp-mgmt-auth-cs-in-progress, rsvp-mgmt-auth-cs-failure, rsvp-mgmt-auth-cs-not-supported
-
Challenge status
- key-digest-info: integer
-
Direction
- key-status: integer
-
Key status
- auth-compact: RSVP-MGMT-AUTHENTICATION-COMPACT
-
Basic authentication data
- direction-info: RSVP-MGMT-AUTH-DIRECTION
-
direction info
- lifetime: integer
-
Lifetime (seconds)
Example
{
"lifetime-left": "integer",
"challenge-status": "string",
"key-digest-info": "integer",
"key-status": "integer",
"auth-compact": {
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
},
"direction-info": {
"receive-info": {
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
},
"send-info": {
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
},
"auth-direction": "string"
},
"lifetime": "integer"
}
RSVP-MGMT-AUTH-DIRECTION:
Union of the different RSVP Authentication Direction types
- receive-info: RSVP-MGMT-AUTH-DIRECTION-RECV
-
receive info
- send-info: RSVP-MGMT-AUTH-DIRECTION-SEND
-
send info
- auth-direction: string rsvp-mgmt-auth-direction-send, rsvp-mgmt-auth-direction-recv
-
AuthDirection
Example
{
"receive-info": {
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
},
"send-info": {
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
},
"auth-direction": "string"
}
RSVP-MGMT-SESSION-UNI-IPV4:
RSVP UNI IPv4 Session
- tunnel-id: integer
-
The Session Tunnel ID
- destination-address: string
-
Destination address
- extended-address: string
-
The Session Extended Address
Example
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
}
RSVP-MGMT-NBR-DETAIL:
Detail Info for RSVP Neighbor
- interface-neighbor-list-detail: RSVP-MGMT-IF-NBR-DETAIL
-
Detail list of I/F Neighbors
-
RSVP-MGMT-IF-NBR-DETAIL - node-address: string
-
Neighbor node address
Example
{
"interface-neighbor-list-detail": [
{
"retransmitted-messages": "integer",
"neighbor-interface-name": "string",
"is-rr-enabled": "boolean",
"neighbor-epoch": "integer",
"interface-neighbor-address": "string",
"out-of-order-messages": "integer"
}
],
"node-address": "string"
}
RSVP-MGMT-SESSION-COMPACT:
RSVP Compact Session Info
- rs-bs: integer
-
Number of reservation state block states
- session: RSVP-MGMT-SESSION-INFO
-
RSVP Session Information
- ps-bs: integer
-
Number of path state block states
- requests: integer
-
Number of request states
- detail-list-size: integer
-
Number of elements in detail list
Example
{
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
}
RSVP-MGMT-RRO-LABEL-SUBOBJ:
RSVP RRO Label subobject
- variable-length-label: object[]
-
The RRO Subobject Variable Length Label
-
object - entry: integer
-
The RRO Subobject Variable Length Label
- is-label-variable-length: boolean
-
Is the RRO Subobject Label Variable Length
- flags: RSVP-MGMT-RRO-LABEL-SUBOBJ-FLAGS
-
The RRO Subobject Label Flags
- label: integer
-
The RRO Subobject Label Value
Example
{
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
}
RSVP-MGMT-INTERFACE-FLAGS:
Interface related flags
- is-rel-s-refresh-enabled: boolean
-
Use reliable xmt for SRefresh
- is-interface-down: boolean
-
Interface is DOWN
- is-backup-tunnel: boolean
-
This is backup tunnel
- is-mpls-enabled: boolean
-
MPLS enabled on interface
- is-s-refresh-enabled: boolean
-
Summary Refresh enabled
- is-refresh-enabled: boolean
-
Refresh enabled
- is-pacing-enabled: boolean
-
Message pacing enabled
- is-non-default-vrf: boolean
-
Interface is defined in non-Default VRF
- is-refresh-reduction-enabled: boolean
-
Refresh Reduction enabled
- is-message-bundling-enabled: boolean
-
Use bundling for outgoing RSVP messages.
- is-interface-created: boolean
-
Interface is created
- is-rsvp-configured: boolean
-
RSVP explicitly configured
Example
{
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
}
INTERFACE-NEIGHBOR-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- interface-neighbor-briefs: object
-
Table of brief info about I/F neighbors
-
- interface-neighbor-brief: object[]
-
Brief info for a single interface neighbor
-
- neighbor-address: string
-
Address of global neighbor
Example
{
"interface-neighbor-briefs": {
"interface-neighbor-brief": [
{
"neighbor-address": "string",
"interface-neighbor-list-compact": [
{
"neighbor-interface-name": "string",
"interface-neighbor-address": "string"
}
],
"node-address": "string"
}
]
}
}
RSVP-MGMT-AUTH-SEND-TYPE-COUNTERS:
RSVP Authentication Send Type Counters
- authentication-challenge-responses-sent: integer
-
Challenge responses sent
- authentication-sent: integer
-
Messages sent
- authentication-send-challenges-received: integer
-
Challenges received
- authentication-failures: integer
-
Failures
Example
{
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
RSVP-MGMT-S2L-SUB-LSP-IPV4:
RSVP S2L Sub-LSP
- s2l-destination-address: string
-
S2L Sub-LSP Destination Address
Example
{
"s2l-destination-address": "string"
}
RSVP-MGMT-RRO-SUBOBJ:
Union of the different RSVP RRO types
- srlg-rro-sub-object: RSVP-MGMT-RRO-SRLG-SUBOBJ
-
SRLG RRO Sub Object
- label-rro-sub-object: RSVP-MGMT-RRO-LABEL-SUBOBJ
-
Label RRO Sub Object
- rro-type: string ipv4rro-type, label-rro-type, unnumbered-rro-type, srlg-rro-type
-
RROType
- ipv4rro-sub-object: RSVP-MGMT-RRO-IPV4-SUBOBJ
-
IPV4 RRO Sub Object
- unnumbered-rro-sub-object: RSVP-MGMT-RRO-UNNUMBERED-SUBOBJ
-
Unnumbered RRO Sub Object
Example
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
REQUEST-DETAIL-TABLE:
Common node of rsvp, rsvp-standby
- request-details: object
-
Table of detail info about requests
-
- request-detail: object[]
-
Detail info for a request
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"request-details": {
"request-detail": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"psb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"rsb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"req-flags": {
"is-rro-in-path": "boolean",
"is-send-confirm": "boolean",
"is-merge-point": "boolean",
"is-refreshing": "boolean",
"is-ack-outstanding": "boolean",
"is-retransmit": "boolean",
"is-label-request-in-path": "boolean",
"is-nack-received": "boolean",
"is-record-label-in-path": "boolean",
"is-message-id-allocated": "boolean",
"is-paced": "boolean",
"is-local-receiver": "boolean"
},
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {}
}
}
]
}
}
RSVP-MGMT-INTERFACE-DETAIL:
Detail Form of RSVP interface Info
- interface-name-xr: string
-
Interface Name
- integrity-send-password: string
-
Integrity send password
- expiry-interval: string
-
Expiry interval in msecs
- bandwidth-information: RSVP-MGMT-DSTE-MODE-INTERFACE-BW
-
Interface bandwidth information
- pacing-timer-state: string rsvp-timer-running-and-sleeping, rsvp-timer-running, rsvp-timer-not-running
-
State of pacing timer
- summary-refresh-max-size: integer
-
Max size in bytes of a single SRefresh
- pacing-message-rate: integer
-
No. of messages per interval
- refresh-interval: string
-
Refresh interval in msecs
- pacing-messages: string
-
Number of messages deferred for pacing
- expiry-drops-tolerated: string
-
Number of missed messages tolerated
- retransmit-time: integer
-
Retransmit time in msec
- out-of-band-expiry-drops-tolerated: integer
-
Number of out-of-band missed messages tolerated
- ack-max-size: integer
-
Max size for ACK message
- expiry-timer-state: string rsvp-timer-running-and-sleeping, rsvp-timer-running, rsvp-timer-not-running
-
Expiry timer state
- integrity-receive-password-optional: integer
-
Integrity recv password optional
- out-of-band-refresh-interval: integer
-
Out-of-band Refresh interval in msecs
- bundle-message-max-size: integer
-
Max size in bytes of a single Bundle message
- ack-hold-time: integer
-
ACK hold time in msec
- refresh-timer-state: string rsvp-timer-running-and-sleeping, rsvp-timer-running, rsvp-timer-not-running
-
Refresh timer state
- summary-refresh-timer-state: string rsvp-timer-running-and-sleeping, rsvp-timer-running, rsvp-timer-not-running
-
Summary refresh timer state
- flags: RSVP-MGMT-INTERFACE-FLAGS
-
Interface flags
- pacing-interval: integer
-
Pacing interval in msecs
- integrity-receive-password: string
-
Integrity receive password
- signalling-ip-tos: integer
-
IP TOS (precedence/DSCP) to use in signalling messages
- expiry-states: string
-
Number of states for expiry check
- neighbor-array: RSVP-MGMT-NBOR
-
Neighbor array
-
RSVP-MGMT-NBOR
Example
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
RSVP-MGMT-COUNT-PREFIX-INTERFACE-INFO:
Prefix filtering interface counters
- default-action-dropped: RSVP-MGMT-COUNT-PREFIX-MSG
-
Count of messages which got dropped due to default ACL action
- forwarded: RSVP-MGMT-COUNT-PREFIX-MSG
-
Count of messages which got forwarded
- default-action-processed: RSVP-MGMT-COUNT-PREFIX-MSG
-
Count of messages which were processed due to default ACL action
- locally-destined: RSVP-MGMT-COUNT-PREFIX-MSG
-
Count of locally destined messages
- dropped: RSVP-MGMT-COUNT-PREFIX-MSG
-
Count of messages dropped
- total: RSVP-MGMT-COUNT-PREFIX-MSG
-
Count of total messages
Example
{
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
RSVP-MGMT-REQUEST-FLAGS:
Request state flags
- is-rro-in-path: boolean
-
The Path message contains RRO
- is-send-confirm: boolean
-
Send Confirm message
- is-merge-point: boolean
-
Is node a Merge Point
- is-refreshing: boolean
-
Is neighbor refreshing
- is-ack-outstanding: boolean
-
Is ACK message outstanding
- is-retransmit: boolean
-
Retransmit the message
- is-label-request-in-path: boolean
-
The Path message contains Label Request
- is-nack-received: boolean
-
A NACK message was received
- is-record-label-in-path: boolean
-
Path has Session-Attr object with Record Labels set
- is-message-id-allocated: boolean
-
Is MessageID allocated
- is-paced: boolean
-
Message is paced
- is-local-receiver: boolean
-
Local Receiver
Example
{
"is-rro-in-path": "boolean",
"is-send-confirm": "boolean",
"is-merge-point": "boolean",
"is-refreshing": "boolean",
"is-ack-outstanding": "boolean",
"is-retransmit": "boolean",
"is-label-request-in-path": "boolean",
"is-nack-received": "boolean",
"is-record-label-in-path": "boolean",
"is-message-id-allocated": "boolean",
"is-paced": "boolean",
"is-local-receiver": "boolean"
}
RSVP-MGMT-GEN-TRAFFIC-SPEC:
Union of different RSVP Generic Sender Tspec types
- tspec-type: string g709otn, intsrv
-
TspecType
- intsrv-tspec: RSVP-MGMT-TRAFFIC-SPEC
-
Integrated Services Sender Tspec
- g709otn-tspec: RSVP-MGMT-TSPEC-G709-OTN
-
G709 OTN Sender Tspec
Example
{
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
}
RSVP-MGMT-GEN-FLOW-SPEC:
Union of different RSVP Generic FlowSpec types
- g709otn-flow-spec: RSVP-MGMT-FLOW-SPEC-G709-OTN
-
G709 OTN FlowSpec
- flow-spec-type: string g709otn
-
FlowSpecType
Example
{
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
RSVP-MGMT-ASSOCIATION-IPV6-EXT:
RSVP EXTENDED ASSOCIATION IPv6 Object Info
- extended-id: object[]
-
Extended Association ID
-
object - entry: integer
-
Extended Association ID
- source: string
-
Association IPV6 Source Address
- global-source: integer
-
Global Association Source
- type: integer
-
Association Type (RFC 4872)
- id: integer
-
Association ID
Example
{
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
}
RSVP-MGMT-POLICY-FLAGS:
RSVP Policy Flags
- is-installed: boolean
-
Installed
- is-accepted: boolean
-
Accepted
- is-forwarding: boolean
-
Forwarding
Example
{
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
}
RSVP-MGMT-TIMESPEC:
RSVP Time Spec
- seconds: string
-
Time Value in Seconds
- nanoseconds: string
-
Time Value in Nano-seconds
Example
{
"seconds": "string",
"nanoseconds": "string"
}
RSVP-MGMT-FILTER-IPV4:
RSVP Filter
- source-port: integer
-
Source Port
- source-address: string
-
Source Address
Example
{
"source-port": "integer",
"source-address": "string"
}
RSVP-MGMT-REV-LSP-UNSUPPORTED-SUBOBJ:
RSVP MGMT REV LSP UNSUPPORTED SUBOBJ
- rsvp-mgmt-rev-lsp-unsupported-subobj: object[]
-
rsvp mgmt rev lsp unsupported subobj
-
object - entry: integer
-
rsvp mgmt rev lsp unsupported subobj
Example
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
{
"entry": "integer"
}
]
}
RSVP-MGMT-PATH-DETAIL:
Detailed Form of RSVP Path Info
- input-interface: string
-
Path Input Interface
- in-ero: RSVP-MGMT-ERO-SUBOBJ
-
Incoming Explicit Route Sub Objects
-
RSVP-MGMT-ERO-SUBOBJ - is-out-ero-valid: boolean
-
Outgoing ERO validity
- header: RSVP-MGMT-HEADER-INFO
-
RSVP Header Info
- session-attribute: RSVP-MGMT-SESSION-ATTRIBUTE
-
RSVP Session Attribute
- session: RSVP-MGMT-SESSION-INFO
-
RSVP Session Information
- policy-source-info: RSVP-MGMT-POLICY-SOURCES
-
Policy Sources Info
- out-ero: RSVP-MGMT-ERO-SUBOBJ
-
Outgoing Explicit Route Sub Objects
-
RSVP-MGMT-ERO-SUBOBJ - backup-tunnel-name: string
-
Path Backup Tunnel
- policy-query-flags: RSVP-MGMT-POLICY-QUERY-FLAGS
-
Policy Query Flags
- expiry-time: RSVP-MGMT-TIMESPEC
-
Expiry Time
- s2l-sub-lsp: RSVP-MGMT-S2L-SUB-LSP-IPV4
-
RSVP S2L Sub-LSP information
- hop: RSVP-MGMT-HOP-INFO
-
Path Hop Info
- generic-traffic-spec: RSVP-MGMT-GEN-TRAFFIC-SPEC
-
RSVP Generic Traffic Spec Info
- pfc: RSVP-PATH-FORWARDING-CONTEXT
-
Path Forwarding Contexts
-
RSVP-PATH-FORWARDING-CONTEXT - template: RSVP-MGMT-FILTER-INFO
-
RSVP Template
- path-flags: RSVP-MGMT-PATH-FLAGS
-
Path Flags
- label-info: RSVP-MGMT-LABEL-INFO
-
Label Information
- is-in-ero-valid: boolean
-
Incoming ERO validity
- class-type: RSVP-MGMT-CT-INFO
-
DS-TE Class-Type
- policy-flags: RSVP-MGMT-POLICY-FLAGS
-
Policy Flags
- traffic-spec: RSVP-MGMT-TRAFFIC-SPEC
-
RSVP Traffic Spec Info
Example
{
"input-interface": "string",
"in-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"is-out-ero-valid": "boolean",
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"policy-source-info": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"out-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"backup-tunnel-name": "string",
"policy-query-flags": {
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
}
}
RSVP-MGMT-FRR-STATE-STATUS-COUNTERS:
FRR state counters
- active-instances: integer
-
Number of active instances of this state
- active-wait-instances: integer
-
Number of instances of this state awaiting Path messages to be sent out or Resv messages to be received
- total: integer
-
Total number of instances of this state
- ready-instances: integer
-
Number of ready instances of this state
Example
{
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
}
RSVP-MGMT-SESSION-ATTRIBUTE:
RSVP Session Attributes
- reservation-priority: integer
-
Reservation Priority
- setup-priority: integer
-
Setup Priority
- sess-attribute-flags: RSVP-MGMT-SESSION-ATTRIBUTE-FLAGS
-
Session Attributes
Example
{
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
}
RSVP-IDT-STATUS:
IDT status information
- withdraw-time: integer
-
Withdraw ready timestamp in seconds
- idt-start-time: integer
-
IDT start timestamp in seconds
- idt-end-time: integer
-
IDT end timestamp in seconds
- declare-time: integer
-
Declare ready timestamp in seconds
- not-ready-reason: string collab-time-out, collab-conntection-idt, nsr-peer-not-connected, nsr-peer-not-in-sync
-
Not ready reason
- sync-status: string not-ready, ready
-
Sync status
Example
{
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
RSVP-MGMT-REQUEST-DETAIL:
Detailed Form of RSVP Request Info
- flow-spec: RSVP-MGMT-FLOW-SPEC
-
Flow Spec Information
- style: RSVP-MGMT-STYLE
-
RSVP Style
- policy-sources: RSVP-MGMT-POLICY-SOURCES
-
RSVP Policy Sources
- psb-key: RSVP-MGMT-KEY
-
List of RSB keys
-
RSVP-MGMT-KEY - header: RSVP-MGMT-HEADER-INFO
-
RSVP Header Information
- rsb-key: RSVP-MGMT-KEY
-
List of RSB keys
-
RSVP-MGMT-KEY - req-flags: RSVP-MGMT-REQUEST-FLAGS
-
Request flags
- filter: RSVP-MGMT-FILTER-INFO
-
RSVP Filter
- s2l-sub-lsp: RSVP-MGMT-S2L-SUB-LSP-IPV4
-
RSVP S2L Sub-LSP information
- session: RSVP-MGMT-SESSION-INFO
-
RSVP Session Information
- hop: RSVP-MGMT-HOP-INFO
-
Hop Infomation
- policy-flags: RSVP-MGMT-POLICY-FLAGS
-
RSVP Policy Flags
- generic-flow-spec: RSVP-MGMT-GEN-FLOW-SPEC
-
Generic Flow Spec Information
- output-interface: string
-
output Interface
- policy-query-flags: RSVP-MGMT-POLICY-QUERY-FLAGS
-
RSVP Query Flags
Example
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"psb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"rsb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"req-flags": {
"is-rro-in-path": "boolean",
"is-send-confirm": "boolean",
"is-merge-point": "boolean",
"is-refreshing": "boolean",
"is-ack-outstanding": "boolean",
"is-retransmit": "boolean",
"is-label-request-in-path": "boolean",
"is-nack-received": "boolean",
"is-record-label-in-path": "boolean",
"is-message-id-allocated": "boolean",
"is-paced": "boolean",
"is-local-receiver": "boolean"
},
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
}
}
}
RSVP-MGMT-ASSOCIATION:
Union of the different ASSOCIATION types
- extended-ipv4: RSVP-MGMT-ASSOCIATION-IPV4-EXT
-
EXTENDED IPV4 ASSOCIATION Object
- extended-ipv6: RSVP-MGMT-ASSOCIATION-IPV6-EXT
-
EXTENDED IPV6 ASSOCIATION Object
- ipv4: RSVP-MGMT-ASSOCIATION-IPV4
-
IPV4 ASSOCIATION Object
- association-type: string none, ipv4, ipv6, extended-ipv4, extended-ipv6
-
AssociationType
- ipv6: RSVP-MGMT-ASSOCIATION-IPV6
-
IPV6 ASSOCIATION Object
Example
{
"extended-ipv4": {
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
},
"extended-ipv6": {
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
},
"ipv4": {
"source": "string",
"type": "integer",
"id": "integer"
},
"association-type": "string",
"ipv6": {
"source": "string",
"type": "integer",
"id": "integer"
}
}
RSVP-MGMT-TSPEC-G709-OTN:
RSVP G709 OTN Sender Tspec Info
- traffic-nvc: integer
-
G709 OTN Traffic NVC
- traffic-multiplier: integer
-
G709 OTN Traffic Multiplier
- traffic-bit-rate: integer
-
G709 OTN Traffic Bit Rate
- traffic-signal-type: integer
-
G709 OTN Traffic Signal Type (Refer G709 v3)
Example
{
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
RSVP-MGMT-MESSAGEID:
RSVP Message ID
- message-id: string
-
Message ID
Example
{
"message-id": "string"
}
RSB-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- rsb-briefs: object
-
Table of brief info about reservation state blocks
-
- rsb-brief: object[]
-
Brief info for a single reservation state block
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"rsb-briefs": {
"rsb-brief": [
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
]
}
}
FRR-TABLE:
Common node of rsvp, rsvp-standby
- frrs: object
-
Table of detailed info about Fast Re-route states
-
- frr: object[]
-
Detailed info for a single Fast Re-route state
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"frrs": {
"frr": [
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"reservation-status": "string",
"path-status": "string"
}
]
}
}
RSVP-MGMT-PATH-COMPACT:
Compact Form of RSVP Path Info
- generic-traffic-spec: RSVP-MGMT-GEN-TRAFFIC-SPEC
-
RSVP Generic Traffic Spec Info
- input-interface: string
-
Path Input Interface
- s2l-sub-lsp: RSVP-MGMT-S2L-SUB-LSP-IPV4
-
RSVP S2L Sub-LSP information
- session-attribute: RSVP-MGMT-SESSION-ATTRIBUTE
-
RSVP Session Attribute
- session: RSVP-MGMT-SESSION-INFO
-
RSVP Session Information
- template: RSVP-MGMT-FILTER-INFO
-
RSVP Template
- traffic-spec: RSVP-MGMT-TRAFFIC-SPEC
-
RSVP Traffic Spec Info
Example
{
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"input-interface": "string",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
RSVP-MGMT-RXSB-DETAIL:
Detailed Form of RSVP Proxy Reservation
- rsvp-header: RSVP-MGMT-HEADER-INFO
-
RSVP Header
- flow-spec: RSVP-MGMT-FLOW-SPEC
-
Flow Spec Information
- style: RSVP-MGMT-STYLE
-
RSVP Style
- input-interface: string
-
Path Input Interface
- dynamic-state: integer
-
Dynamic State Handle
- filter: RSVP-MGMT-FILTER-INFO
-
RSVP Filter
- s2l-sub-lsp: RSVP-MGMT-S2L-SUB-LSP-IPV4
-
RSVP S2L Sub-LSP information
- session: RSVP-MGMT-SESSION-INFO
-
RSVP Session Information
- hop: RSVP-MGMT-HOP-INFO
-
Path Hop Info
- generic-flow-spec: RSVP-MGMT-GEN-FLOW-SPEC
-
Generic Flow Spec Information
Example
{
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"dynamic-state": "integer",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"hop": {
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
FRR-SUMMARY:
Common node of rsvp, rsvp-standby
- frr-summary: RSVP-MGMT-FRR-STATES-COMPACT
-
Fast Re-Route Summary State Information
Example
{
"frr-summary": {
"reservation-states": {
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
},
"path-states": {
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
}
}
}
RSVP-MGMT-HELLO-IF-INSTANCE-COMPACT:
Compact Info for IF-based RSVP Hello Instance
- instance-type: string active, passive
-
Hello instance type
- destination-address-xr: string
-
Destination address
- hello-interface: string
-
Interface to use
- source-address-xr: string
-
Source address
Example
{
"instance-type": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string"
}
RSVP-MGMT-PXSB-DETAIL:
Detailed Form of RSVP Proxy Path
- rsvp-header: RSVP-MGMT-HEADER-INFO
-
RSVP Header
- generic-traffic-spec: RSVP-MGMT-GEN-TRAFFIC-SPEC
-
RSVP Generic Traffic Spec Info
- template: RSVP-MGMT-FILTER-INFO
-
RSVP Template
- input-interface: string
-
Path Input Interface
- dynamic-state: integer
-
Dynamic State Handle
- s2l-sub-lsp: RSVP-MGMT-S2L-SUB-LSP-IPV4
-
RSVP S2L Sub-LSP information
- session: RSVP-MGMT-SESSION-INFO
-
RSVP Session Information
- hop: RSVP-MGMT-HOP-INFO
-
Path Hop Info
- traffic-spec: RSVP-MGMT-TRAFFIC-SPEC
-
RSVP Traffic Spec Info
Example
{
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"input-interface": "string",
"dynamic-state": "integer",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"hop": {
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
RSVP-MGMT-IF-NBR-COMPACT:
Compact Info for RSVP Interface Neighbor
- neighbor-interface-name: string
-
Neighbor's Interface handle
- interface-neighbor-address: string
-
Interface Neighbor address
Example
{
"neighbor-interface-name": "string",
"interface-neighbor-address": "string"
}
RSVP-MGMT-GENERALIZED-LABEL:
RSVP Generalized Label
- value: object[]
-
Generalized Label Value
-
object - entry: integer
-
Generalized Label Value
Example
{
"value": [
{
"entry": "integer"
}
]
}
HELLO-INSTANCE-DETAIL-TABLE:
Common node of rsvp, rsvp-standby
- hello-instance-details: object
-
Table of detailed info about hello instances
-
- hello-instance-detail: object[]
-
Detailed info for a single hello instance
-
- destination-address: string
-
Destination Address
- source-address: string
-
Source Address
Example
{
"hello-instance-details": {
"hello-instance-detail": [
{
"destination-address": "string",
"source-address": "string",
"communication-lost-wrong-source-inst": "integer",
"communication-lost-reason": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"destination-instance": "integer",
"instance-type": "string",
"communication-lost-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-request-suppressed": "integer",
"communication-lost-hello-missed": "integer",
"missed-acks-allowed": "integer",
"communication-lost-neighbor-disabled-hello": "integer",
"total-communication-lost": "integer",
"communication-lost-interface-down": "integer",
"neighbor-hello-state": "string",
"hello-interval": "integer",
"source-address-xr": "string",
"source-instance": "integer",
"hello-messages-received": "integer",
"hello-instance-owner": "string",
"up-time": {
"seconds": "string",
"nanoseconds": "string"
},
"communication-lost-wrong-destination-inst": "integer",
"hello-messages-sent": "integer"
}
]
}
}
CONTROLLER-SUMMARY-TABLE:
Common node of rsvp, rsvp-standby
- controller-summaries: object
-
Table of summary info about RSVP-enabled controllers
-
- controller-summary: object[]
-
Summary info about an RSVP-enabled controller
-
- controller-name: string
-
Controller Name
Example
{
"controller-summaries": {
"controller-summary": [
{
"controller-name": "string",
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
]
}
}
RSVP-MGMT-COUNTERS-OOR:
Counters for all messages dropped in OOR condition
- dropped-path-messages: integer
-
Count of Path messages dropped due to an out of resource condition
Example
{
"dropped-path-messages": "integer"
}
RSVP-MGMT-ASSOCIATION-IPV6:
RSVP ASSOCIATION IPv6 Object Info
- source: string
-
Association IPV6 Source Address
- type: integer
-
Association Type (RFC 4872)
- id: integer
-
Association ID
Example
{
"source": "string",
"type": "integer",
"id": "integer"
}
RSVP-MGMT-ERO-IPV4-SUBOBJ:
RSVP ERO IPV4 subobject
- prefix-length: integer
-
ERO Prefix Length
- ero-address: string
-
The ERO IPV4 Address
- is-strict-route: boolean
-
ERO Entry Is Strict
Example
{
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
}
PSB-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- psb-briefs: object
-
Table of brief info about path state blocks
-
- psb-brief: object[]
-
Brief info for a single path state block
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"psb-briefs": {
"psb-brief": [
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"input-interface": "string",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
]
}
}
RSVP-MGMT-ERO-UNNUM-SUBOBJ:
RSVP ERO UNNUM subobject
- status: string rsvp-mgmt-ero-status-not-available, rsvp-mgmt-ero-status-available, rsvp-mgmt-ero-status-bw-not-available
-
Status of ERO
- ero-interface-id: integer
-
The Interface ID in ERO
- is-strict-route: boolean
-
ERO Entry Is Strict
- ero-router-id: string
-
The Router ID in ERO
Example
{
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
}
SUMMARY:
Common node of rsvp, rsvp-standby
- summary: RSVP-GLOBAL-INFO
-
RSVP summary information
Example
{
"summary": {
"ls-ps": "integer",
"interfaces": "integer",
"issu-status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
},
"database-counters": {
"incoming-paths": "integer",
"sessions": "integer",
"interfaces": "integer",
"outgoing-paths": "integer",
"outgoing-reservations": "integer",
"incoming-reservations": "integer"
},
"nsr-status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
}
}
RSVP-MGMT-GLBL-NBR-DETAIL:
Detail Info for RSVP Global Neighbor
- global-neighbor-flags: RSVP-MGMT-GLBL-NBR-FLAGS
-
Global Neighbor Flags
- lost-communication-reason: object[]
-
Reason why communication was lost
-
object - entry: string not-applicable, wrong-destination-instance, wrong-source-instance, hello-missed, interface-down, neighbor-disabled-hello, control-channel-down
-
Reason why communication was lost
- local-node-address: object[]
-
Local node address
-
object - entry: string
-
Local node address
- up-time: RSVP-MGMT-TIMESPEC
-
Hello up time
-
RSVP-MGMT-TIMESPEC - restart-timer-expiry-time: RSVP-MGMT-TIMESPEC
-
When will restart timer expire
- missed-hellos: integer
-
Hello missed count
- lost-communication-time: RSVP-MGMT-TIMESPEC
-
Time when communication was lost
-
RSVP-MGMT-TIMESPEC - recovery-time-left: RSVP-MGMT-TIMESPEC
-
How much recovery timer remains
- is-restart-timer-running: boolean
-
Is GR restart timer running
- neighbor-hello-state: object[]
-
Neighbor's hello state
-
object - entry: string hello-state-init, hello-state-up, hello-state-down
-
Neighbor's hello state
- pending-states: integer
-
Number of pending states for this neighbor
- is-recovery-timer-running: boolean
-
Is RSVP recovery timer running
- restart-time: integer
-
GR Restart Time (milliseconds)
- restart-state: string done, recovery, abort
-
Current restart state
- hello-interval: integer
-
Hello Interval (milliseconds)
- lost-communication-total: object[]
-
Total number of times communication got lost
-
object - entry: integer
-
Total number of times communication got lost
- is-gr-enabled: boolean
-
Is GR enabled
- interface-neighbor: object[]
-
Interface Neighbor List
-
object - entry: string
-
Interface Neighbor List
- restart-time-left: RSVP-MGMT-TIMESPEC
-
How much restart time remains
- recovery-time: integer
-
GR Recovery Time (milliseconds)
- node-address: string
-
Neighbor node address
- recovery-timer-exp-time: RSVP-MGMT-TIMESPEC
-
Time at which recovery timer will expire
Example
{
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"restart-timer-expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"missed-hellos": "integer",
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"is-restart-timer-running": "boolean",
"neighbor-hello-state": [
{
"entry": "string"
}
],
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer",
"restart-state": "string",
"hello-interval": "integer",
"lost-communication-total": [
{
"entry": "integer"
}
],
"is-gr-enabled": "boolean",
"interface-neighbor": [
{
"entry": "string"
}
],
"restart-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"recovery-time": "integer",
"node-address": "string",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
}
}
RSVP-MGMT-RESERVATION-DETAIL:
Detailed Form of RSVP Reservation Info
- flow-spec: RSVP-MGMT-FLOW-SPEC
-
Flow Spec Information
- style: RSVP-MGMT-STYLE
-
RSVP Style
- policy-sources: RSVP-MGMT-POLICY-SOURCES
-
RSVP Policy Sources
- header: RSVP-MGMT-HEADER-INFO
-
RSVP Header Information
- expiry-time: RSVP-MGMT-TIMESPEC
-
Expiry Time
- label-info: RSVP-MGMT-LABEL-INFO
-
Label Information
- input-adjusted-interface: string
-
Input Adjusted Interface
- filter: RSVP-MGMT-FILTER-INFO
-
RSVP Filter
- s2l-sub-lsp: RSVP-MGMT-S2L-SUB-LSP-IPV4
-
RSVP S2L Sub-LSP information
- session: RSVP-MGMT-SESSION-INFO
-
RSVP Session Information
- input-physical-interface: string
-
Input Physical Interface
- hop: RSVP-MGMT-HOP-INFO
-
Hop Infomation
- policy-flags: RSVP-MGMT-POLICY-FLAGS
-
RSVP Policy Flags
- generic-flow-spec: RSVP-MGMT-GEN-FLOW-SPEC
-
Generic Flow Spec Information
- rsb-flags: RSVP-MGMT-RSB-FLAGS
-
Reservation State Block Flags
- policy-query-flags: RSVP-MGMT-POLICY-QUERY-FLAGS
-
RSVP Query Flags
Example
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"label-info": {
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
},
"input-adjusted-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer"
}
}
}
}
INTERFACE-DETAILED-TABLE:
Common node of rsvp, rsvp-standby
- interface-detaileds: object
-
Table of detailed info about RSVP-enabled interfaces
-
- interface-detailed: object[]
-
Detailed info about an RSVP-enabled interface
-
- interface-name: string
-
Interface Name
Example
{
"interface-detaileds": {
"interface-detailed": [
{
"interface-name": "string",
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
]
}
}
RSVP-MGMT-FRR-STATES-DETAIL:
RSVP states for one FRR LSP
- s2l-sub-lsp: RSVP-MGMT-S2L-SUB-LSP-IPV4
-
RSVP S2L Sub-LSP information
- session: RSVP-MGMT-SESSION-INFO
-
RSVP Session Information
- reservation-status: string ready-state, pending-state, active-state
-
RSVP FRR Reservation States
- path-status: string ready-state, pending-state, active-state
-
RSVP FRR Path States
Example
{
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"reservation-status": "string",
"path-status": "string"
}
RSVP-MGMT-ERO-SUBOBJ:
Union of the different RSVP ERO types
- unnumbered-ero-sub-object: RSVP-MGMT-ERO-UNNUM-SUBOBJ
-
Unnumbered ERO Sub Object
- ipv4ero-sub-object: RSVP-MGMT-ERO-IPV4-SUBOBJ
-
IPV4 ERO Sub Object
- ero-type: string rsvp-mgmt-ero-type-ipv4, rsvp-mgmt-ero-type-un-num
-
EROType
Example
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
RSVP-MGMT-SESSION-LSP-TUNNEL-IPV4:
RSVP LSP-Tunnel-IPv4 Session
- tunnel-id: integer
-
The Session Tunnel ID
- destination-address: string
-
Destination address
- extended-tunnel-id: string
-
The Session Extended Tunnel ID
Example
{
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
}
RSVP-MGMT-RESERVATION-COMPACT:
Compact Form of RSVP Reservation Info
- flow-spec: RSVP-MGMT-FLOW-SPEC
-
Flow Spec Information
- style: RSVP-MGMT-STYLE
-
RSVP Style
- input-interface: string
-
Reservation Input Interface
- filter: RSVP-MGMT-FILTER-INFO
-
RSVP Filter
- s2l-sub-lsp: RSVP-MGMT-S2L-SUB-LSP-IPV4
-
RSVP S2L Sub-LSP information
- session: RSVP-MGMT-SESSION-INFO
-
RSVP Session Information
- generic-flow-spec: RSVP-MGMT-GEN-FLOW-SPEC
-
Generic Flow Spec Info
Example
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
RSVP-MGMT-GLBL-NBR-COMPACT:
Compact Info for RSVP Global Neighbor
- restart-state: string done, recovery, abort
-
Restart state
- global-neighbor-flags: RSVP-MGMT-GLBL-NBR-FLAGS
-
Global Neighbor Flags
- lost-communication-reason: object[]
-
Reason why communication was lost
-
object - entry: string not-applicable, wrong-destination-instance, wrong-source-instance, hello-missed, interface-down, neighbor-disabled-hello, control-channel-down
-
Reason why communication was lost
- lost-communication-total: object[]
-
Total number of times communication got lost
-
object - entry: integer
-
Total number of times communication got lost
- lost-communication-time: RSVP-MGMT-TIMESPEC
-
Time when communication was lost
-
RSVP-MGMT-TIMESPEC - is-gr-enabled: boolean
-
Is GR enabled
- local-node-address: object[]
-
Local node address
-
object - entry: string
-
Local node address
- up-time: RSVP-MGMT-TIMESPEC
-
Time hellos have been up
-
RSVP-MGMT-TIMESPEC - node-address: string
-
Neighbor node address
- neighbor-hello-state: object[]
-
Neighbor Hello state
-
object - entry: string hello-state-init, hello-state-up, hello-state-down
-
Neighbor Hello state
Example
{
"restart-state": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"lost-communication-total": [
{
"entry": "integer"
}
],
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"is-gr-enabled": "boolean",
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"node-address": "string",
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
RSVP-MGMT-PROTECTION:
RSVP PROTECTION Object Info
- link-flags: RSVP-MGMT-PROTECTION-LINK-FLAGS
-
PROTECTION Object Link Flags
- s: boolean
-
Secondary Bit
- o: boolean
-
Operational Bit
- n: boolean
-
Notification Bit
- p: boolean
-
Protecting Bit
- lsp-flags: RSVP-MGMT-PROTECTION-LSP-FLAGS
-
PROTECTION Object LSP Flags
Example
{
"link-flags": {
"reserved-bit2": "boolean",
"reserved-bit1": "boolean",
"unprotected": "boolean",
"ded1-plus1": "boolean",
"enhanced": "boolean",
"shared": "boolean",
"extra-traffic": "boolean",
"ded1-to1": "boolean"
},
"s": "boolean",
"o": "boolean",
"n": "boolean",
"p": "boolean",
"lsp-flags": {
"rerouting-no-et": "boolean",
"one-plus-one-uni": "boolean",
"one-plus-one-bi": "boolean",
"rerouting": "boolean",
"one-to-n-protection-et": "boolean"
}
}
RSVP-SESSION-RSB-DETAIL:
RSVP Detail Session Reservation Info
- generic-out-label: RSVP-MGMT-GENERIC-LABEL
-
Generic Label for outbound traffic
- flow-spec: RSVP-MGMT-FLOW-SPEC
-
Flow spec object
- out-interface: string
-
Interface on which outbound message was sent
- is-valid: boolean
-
Entry validity
- is-flow-spec-valid: boolean
-
FlowSpec validity
- rro: RSVP-MGMT-RRO-SUBOBJ
-
Record route object
-
RSVP-MGMT-RRO-SUBOBJ - is-rro-valid: boolean
-
RRO validity
- destination-address: string
-
Destination address
- backup-label: string
-
Backup label
- out-label: string
-
Label for outbound traffic
- generic-flow-spec: RSVP-MGMT-GEN-FLOW-SPEC
-
Generic Flow Spec object
- backup-interface: string
-
Backup tunnel interface
Example
{
"generic-out-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"out-interface": "string",
"is-valid": "boolean",
"is-flow-spec-valid": "boolean",
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-rro-valid": "boolean",
"destination-address": "string",
"backup-label": "string",
"out-label": "string",
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
},
"backup-interface": "string"
}
AUTHENTICATION-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- authentication-briefs: object
-
Table for Authentication related information
-
- authentication-brief: object[]
-
Brief Authentication information
-
- mode-id: string send, receive
-
Mode (Tx or Rx)
- destination-address: string
-
Destination Address
- interface-name: string
-
InterfaceName
- source-address: string
-
Source Address
Example
{
"authentication-briefs": {
"authentication-brief": [
{
"mode-id": "string",
"destination-address": "string",
"interface-name": "string",
"source-address": "string",
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
}
]
}
}
INTERFACE-SUMMARY-TABLE:
Common node of rsvp, rsvp-standby
- interface-summaries: object
-
Table of summary info about RSVP-enabled interfaces
-
- interface-summary: object[]
-
Summary info about an RSVP-enabled interface
-
- interface-name: string
-
Interface Name
Example
{
"interface-summaries": {
"interface-summary": [
{
"interface-name": "string",
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
]
}
}
RSVP-SESSION-PSB-RSB-DETAIL:
List of Path and Reservation Info
- psb-info: RSVP-SESSION-PSB-DETAIL
-
Path Info
-
RSVP-SESSION-PSB-DETAIL - rsb-info: RSVP-SESSION-RSB-DETAIL
-
Reservation Info
-
RSVP-SESSION-RSB-DETAIL
Example
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"p2mp-sub-group-origin": "string",
"reverse-lsp": {
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"unsup-sub-object": [
null
]
}
}
]
}
RSVP-MGMT-RRO-LABEL-SUBOBJ-FLAGS:
RSVP RRO Label Subobject Flags
- is-global-label: boolean
-
Label is Global across all interfaces
Example
{
"is-global-label": "boolean"
}
RSVP-MGMT-ASSOCIATION-IPV4-EXT:
RSVP EXTENDED ASSOCIATION IPv4 Object Info
- extended-id: object[]
-
Extended Association ID
-
object - entry: integer
-
Extended Association ID
- source: string
-
Association IPV4 Source Address
- global-source: integer
-
Global Association Source
- type: integer
-
Association Type (RFC 4872)
- id: integer
-
Association ID
Example
{
"extended-id": [
{
"entry": "integer"
}
],
"source": "string",
"global-source": "integer",
"type": "integer",
"id": "integer"
}
RSVP-MGMT-SESSION-ATTRIBUTE-FLAGS:
RSVP Session Attribute Flags
- is-local-protect: boolean
-
Local Protection
- is-node-protect: boolean
-
Node Protection
- is-bandwidth-protect: boolean
-
Bandwidth Protection
- is-shared-explicit-requested: boolean
-
Shared Explicit Requested
- is-record-labels: boolean
-
Records Labels
Example
{
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
RSVP-MGMT-PATH-FLAGS:
RSVP Path Flags
- is-bidirectional: boolean
-
Bidirectional
- is-lockout: boolean
-
Locked Out
- is-non-rsvp-hop-upstream: boolean
-
Non-RSVP Hop Upstream
- is-message-id-valid: boolean
-
MessageID Valid
- is-local-sender: boolean
-
Local Sender
- is-local-repair: boolean
-
Rerouted
Example
{
"is-bidirectional": "boolean",
"is-lockout": "boolean",
"is-non-rsvp-hop-upstream": "boolean",
"is-message-id-valid": "boolean",
"is-local-sender": "boolean",
"is-local-repair": "boolean"
}
INTERFACE-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- interface-briefs: object
-
Table of brief info about RSVP-enabled interfaces
-
- interface-brief: object[]
-
Brief info about an RSVP-enabled interface
-
- interface-name: string
-
Interface Name
Example
{
"interface-briefs": {
"interface-brief": [
{
"interface-name": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
]
}
}
RSVP-MGMT-RRO-IPV4-SUBOBJ:
RSVP RRO IPV4 subobject
- flags: RSVP-MGMT-RRO-IPV4-SUBOBJ-FLAGS
-
The RRO IPV4 Subobject Flags
- rro-address: string
-
The RRO IPV4 Address
Example
{
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
}
RSVP-MGMT-CT-INFO:
Class-Type Information
- is-class-type-info-valid: boolean
-
Is the Class-Type information valid
- class-type: integer
-
DS-TE Class-Type
Example
{
"is-class-type-info-valid": "boolean",
"class-type": "integer"
}
RSVP-MGMT-INTERFACE-BW-PRESTD-DSTE:
Prestandard DSTE interface bandwidth information
- is-max-bandwidth-absolute: boolean
-
True if the Max B/W is an absolute value and false if its a percentage
- is-max-subpool-bandwidth-absolute: boolean
-
True if the Max sub-pool B/W is an absolute value and false if its a percentage
- allocated-bit-rate: integer
-
Bandwidth (bits per second) now allocated
- max-flow-bandwidth: integer
-
Max bandwidth (bits per second) allowed per flow
- max-subpool-bandwidth: integer
-
Max bandwidth (bits per second) allowed in subpool
- max-bandwidth: integer
-
Max bandwidth (bits per second) allowed
Example
{
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
RSVP-MGMT-COUNT-MESSAGE:
Counters for all messages
- transmitted-messages: RSVP-MGMT-COUNTS
-
Count of messages transmitted
- retransmitted-messages: integer
-
Count of messages retransmitted
- rate-limited-messages: integer
-
Count of Rate Limited messages
- received-messages: RSVP-MGMT-COUNTS
-
Count of messages received
- bundle-received-messages: RSVP-MGMT-COUNTS
-
Count of Bundle messages received
- bundle-transmitted-messages: RSVP-MGMT-COUNTS
-
Count of Bundle messages transmitted
- out-of-order-messages: integer
-
Count of Out of Order messages
Example
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
RSVP-MGMT-PROTECTION-LSP-FLAGS:
RSVP PROTECTION Object LSP Flags
- rerouting-no-et: boolean
-
Rerouting Without Extra-Traffic
- one-plus-one-uni: boolean
-
1+1 Unidirectional Protection
- one-plus-one-bi: boolean
-
1+1 Bidirectional Protection
- rerouting: boolean
-
Full Rerouting
- one-to-n-protection-et: boolean
-
1:N Protection with Extra-Traffic
Example
{
"rerouting-no-et": "boolean",
"one-plus-one-uni": "boolean",
"one-plus-one-bi": "boolean",
"rerouting": "boolean",
"one-to-n-protection-et": "boolean"
}
RSVP-MGMT-FRR-STATES-COMPACT:
Count of RSVP FRR States
- reservation-states: RSVP-MGMT-FRR-STATE-STATUS-COUNTERS
-
Rerservation state counters
- path-states: RSVP-MGMT-FRR-STATE-STATUS-COUNTERS
-
Path state counters
Example
{
"reservation-states": {
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
},
"path-states": {
"active-instances": "integer",
"active-wait-instances": "integer",
"total": "integer",
"ready-instances": "integer"
}
}
RSVP-MGMT-FLOW-SPEC-G709-OTN:
RSVP G709 OTN FlowSpec Info
- flow-bit-rate: integer
-
G709 OTN Flow Bit Rate
- flow-signal-type: integer
-
G709 OTN Flow Signal Type (Refer G709 v3)
- flow-multiplier: integer
-
G709 OTN Flow Multiplier
- flow-nvc: integer
-
G709 OTN Flow NVC
Example
{
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
}
RSVP-PATH-FORWARDING-CONTEXT:
RSVP Path Forwarding Context
- policy-flags: RSVP-MGMT-POLICY-FLAGS
-
Policy Flags
- output-interface: string
-
Output interface
- policy-query-flags: RSVP-MGMT-POLICY-QUERY-FLAGS
-
Policy Query Flags
Example
{
"policy-flags": {
"is-installed": "boolean",
"is-accepted": "boolean",
"is-forwarding": "boolean"
},
"output-interface": "string",
"policy-query-flags": {
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
}
}
RSVP-MGMT-INTERFACE-BW-STD-DSTE:
RSVP interface bandwidth info with standard based DSTE enabled
- is-max-bandwidth-absolute: boolean
-
True if the Max B/W is an absolute value and false if its a percentage
- max-pool1-bandwidth: integer
-
Max bandwidth (bits per second) allowed in BC1 pool
- allocated-bit-rate: integer
-
Bandwidth (bits per second) now allocated
- max-pool0-bandwidth: integer
-
Max bandwidth (bits per second) allowed in BC0 pool
- max-flow-bandwidth: integer
-
Max bandwidth (bits per second) allowed per flow
- is-max-bc1-bandwidth-absolute: boolean
-
True if the Max BC1 sub-pool B/W is an absolute value and false if its a percentage
- is-max-bc0-bandwidth-absolute: boolean
-
True if the Max BC0 B/W is an absolute value and false if its a percentage
- max-bandwidth: integer
-
Max bandwidth (bits per second) allowed
Example
{
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
}
RSVP-MGMT-AUTH-DIRECTION-RECV:
RSVP Authentication Recieve Type Information
- sequence-window-size: integer
-
Sequence window size
- sequence: integer
-
Sequence number
- sequence-window-count: integer
-
Sequence window count
- sequence-window: object[]
-
Sequence window
-
object - entry: integer
-
Sequence window
- counters: RSVP-MGMT-AUTH-RECV-TYPE-COUNTERS
-
Counters
Example
{
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
}
NSR:
Common node of rsvp, rsvp-standby
- nsr: object
-
RSVP NSR information
-
- status: RSVP-NSR-ISSU-STATUS-INFO
-
RSVP NSR status information
Example
{
"nsr": {
"status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
}
}
REQUEST-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- request-briefs: object
-
Table of brief info about requests
-
- request-brief: object[]
-
Brief info for a request
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"request-briefs": {
"request-brief": [
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"output-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
]
}
}
RSVP-MGMT-HEADER-INFO:
RSVP/IP Header Info
- rsvp-version: integer
-
RSVP Version
- ip-ttl: integer
-
IP TTL
- ip-tos: integer
-
IP Type of Service
- rsvp-header-flags: integer
-
RSVP Header Flags (defined in RFC2205 Section 3 .1.1)
- ip-source-address: string
-
IP Source Address
- rsvp-message-type: integer
-
RSVP Message Type
- rsvp-ttl: integer
-
RSVP TTL
Example
{
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
}
RSVP-MGMT-LABEL-INFO:
Label Information
- is-valid: boolean
-
Is the label information valid
- lsp-wrap-label: string
-
LSP Wrap Label
- local-downstream-label: string
-
Local Downstream Label
- generic-local-downstream-label: RSVP-MGMT-GENERIC-LABEL
-
Generic Local Downstream Label
- generic-recovery-label: RSVP-MGMT-GENERIC-LABEL
-
Generic Recovery Label
- outgoing-downstream-label: string
-
Outgoing Downstream Label
- local-upstream-label: string
-
Local Upstream Label
- generic-merge-point-label: RSVP-MGMT-GENERIC-LABEL
-
Generic MergePoint Label
- recovery-label: string
-
Recovery Label
- outgoing-upstream-label: string
-
Outgoing Upstream Label
- generic-outgoing-downstream-label: RSVP-MGMT-GENERIC-LABEL
-
Generic Outgoing Downstream Label
- generic-local-upstream-label: RSVP-MGMT-GENERIC-LABEL
-
Generic Local Upstream Label
- merge-point-label: string
-
MergePoint Label
- generic-outgoing-upstream-label: RSVP-MGMT-GENERIC-LABEL
-
Generic Outgoing Upstream Label
Example
{
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
}
RSVP-MGMT-SESSION-UDP-IPV4:
RSVP UDP IPv4 Session
- destination-port: integer
-
The Session Destination Port
- protocol: integer
-
Protocol type (originally defined in RFC 790, further values in subsequent RFCs)
- destination-address: string
-
Destination address
Example
{
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
}
RSVP-SESSION-PSB-DETAIL:
RSVP Detail Session Path Info
- rro: RSVP-MGMT-RRO-SUBOBJ
-
Record Route Sub Objects
-
RSVP-MGMT-RRO-SUBOBJ - is-valid: boolean
-
Entry validity
- tunnel-name: string
-
Tunnel name
- in-label: string
-
Label for inbound traffic
- is-bad-address: boolean
-
Address validity
- incoming-interface-address: string
-
IP address of Path's incoming interface
- generic-traffic-spec: RSVP-MGMT-GEN-TRAFFIC-SPEC
-
Generic Traffic Spec object
- p2mp-sub-group-origin: string
-
Point to Multipoint SubGroup Origin
- reverse-lsp: RSVP-MGMT-REVERSE-LSP
-
Reverse LSP object
- lsp-wrap-label: string
-
LSP Wrap Label
- is-rro-valid: boolean
-
RRO validity
- sub-group-id: integer
-
Point to Multipoint Subgroup ID
- protection: RSVP-MGMT-PROTECTION
-
Protection object
- destination-address: string
-
Destination address
- association: RSVP-MGMT-ASSOCIATION
-
Association object
- in-interface: string
-
Interface on which inbound message was received
- generic-in-label: RSVP-MGMT-GENERIC-LABEL
-
Generic Label for inbound traffic
- is-traffic-spec-valid: boolean
-
Traffic Spec validity
- is-ero-valid: boolean
-
ERO validity
- traffic-spec: RSVP-MGMT-TRAFFIC-SPEC
-
Traffic Spec object
- ero: RSVP-MGMT-ERO-SUBOBJ
-
Explicit Route Sub Objects
-
RSVP-MGMT-ERO-SUBOBJ - lsp-id: integer
-
LSP ID
Example
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"p2mp-sub-group-origin": "string",
"reverse-lsp": {
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"unsup-sub-object": [
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [
null
]
}
]
}
}
CONTROLLER-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- controller-briefs: object
-
Table of brief info about RSVP-enabled controller
-
- controller-brief: object[]
-
Brief info about an RSVP-enabled controller
-
- controller-name: string
-
Controller Name
Example
{
"controller-briefs": {
"controller-brief": [
{
"controller-name": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
]
}
}
CONTROLLER-DETAILED-TABLE:
Common node of rsvp, rsvp-standby
- controller-detaileds: object
-
Table of detailed info about RSVP-enabled controllers
-
- controller-detailed: object[]
-
Detailed info about an RSVP-enabled controller
-
- controller-name: string
-
Controller Name
Example
{
"controller-detaileds": {
"controller-detailed": [
{
"controller-name": "string",
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
]
}
}
RSVP-MGMT-KEY:
Key to uniquely identify some RSVP records
- vrfid: string
-
Signalling VRF ID
- protocol: integer
-
Protocol. UDP session type this represents the Protocol (UDP not supported at present)
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Protocol or Extended Tunnel ID. For the LSP and OUNI sesion types this represents the Extended Tunnel ID
- destination-port-or-tunnel-id: integer
-
Destination Port or Tunnel ID. For the LSP and OUNI session types this represents the Tunnel ID whereas for the UDP session type this represents the Destination Port
- sub-group-id: integer
-
Point to Multipoint Subgroup ID
- destination-address: string
-
Destination address
- session-type: string rsvp-mgmt-session-type-udp-ipv4, rsvp-mgmt-session-type-lsp-ipv4, rsvp-mgmt-session-type-uni-ipv4, rsvp-mgmt-session-type-p2mp-lsp-ipv4
-
Session Type (e.g. LSP, OUNI or UDP)
- p2mp-sub-group-origin: string
-
Point to Multipoint SubGroup Origin
- p2mp-id: integer
-
Point-to-multipoint ID
- source-port-or-lsp-id: integer
-
Source Port or LSP_ID. For the LSP and OUNI session types this represents the LSP_ID whereas for the UDP session type this represents the SourcePort
Example
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
RSVP-NSR-ISSU-STATUS-INFO:
NSR/ISSU status information
- role: string unknown, v1-active, v1-standby, v2-active, v2-standby, v1-active-post-big-bang, v1-standby-post-big-bang, count
-
Process role
- idt-status: RSVP-IDT-STATUS
-
IDT status
- previous-idt-status: RSVP-IDT-STATUS
-
Previous IDT status
Example
{
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
RSVP-MGMT-ASSOCIATION-IPV4:
RSVP ASSOCIATION IPv4 Object Info
- source: string
-
Association IPV4 Source Address
- type: integer
-
Association Type (RFC 4872)
- id: integer
-
Association ID
Example
{
"source": "string",
"type": "integer",
"id": "integer"
}
GRACEFUL-RESTART:
Common node of rsvp, rsvp-standby
- graceful-restart: RSVP-MGMT-GRACEFUL-RESTART
-
Info about graceful-restart
Example
{
"graceful-restart": {
"missed-hellos": "integer",
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-interval": "integer",
"global-neighbors": "integer",
"is-gr-enabled": "boolean",
"local-node-address": [
{
"local-node-ip-address": "string",
"application-type": "string"
}
],
"recovery-time": "integer",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
},
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer"
}
}
RSVP-MGMT-HELLO-IF-INSTANCE-DETAIL:
Detail Info for IF-based RSVP Hello Instance
- last-message-sent-time: RSVP-MGMT-TIMESPEC
-
Last Ack/msg sent time
- hello-messages-received: integer
-
Number of hello messages received
- hello-global-neighbor-id: string
-
Global Neighbor ID
- destination-address-xr: string
-
Destination address
- hello-interface: string
-
Interface to use
- source-address-xr: string
-
Source address
- destination-instance: integer
-
Destination Instance
- instance-type: string active, passive
-
Hello instance type
- source-instance: integer
-
Source Instance
- hello-messages-sent: integer
-
Number of hello messages sent
Example
{
"last-message-sent-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-messages-received": "integer",
"hello-global-neighbor-id": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"destination-instance": "integer",
"instance-type": "string",
"source-instance": "integer",
"hello-messages-sent": "integer"
}
RSVP-MGMT-TRAFFIC-SPEC:
RSVP Traffic Spec Info
- traffic-max-burst: integer
-
Traffic Maximum Burst
- traffic-max-unit: integer
-
Traffic Maximum Unit
- traffic-average-rate: integer
-
Traffic Average Rate in bytes per second
- traffic-peak-rate: integer
-
Traffic Peak Rate in bytes per second
- traffic-min-unit: integer
-
Traffic Minimum Unit
Example
{
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
HELLO-INTERFACE-INSTANCE-DETAIL-TABLE:
Common node of rsvp, rsvp-standby
- hello-interface-instance-details: object
-
Table of detailed info about i/f-based hello instances
-
- hello-interface-instance-detail: object[]
-
Detailed info for a single interface-based hello instance
-
- destination-address: string
-
Destination Address
- source-address: string
-
Source Address
Example
{
"hello-interface-instance-details": {
"hello-interface-instance-detail": [
{
"destination-address": "string",
"source-address": "string",
"last-message-sent-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-messages-received": "integer",
"hello-global-neighbor-id": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"destination-instance": "integer",
"instance-type": "string",
"source-instance": "integer",
"hello-messages-sent": "integer"
}
]
}
}
GLOBAL-NEIGHBOR-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- global-neighbor-briefs: object
-
Table of brief info about global neighbors
-
- global-neighbor-brief: object[]
-
Brief info for a single global neighbor
-
- neighbor-address: string
-
Address of global neighbor
Example
{
"global-neighbor-briefs": {
"global-neighbor-brief": [
{
"neighbor-address": "string",
"restart-state": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"lost-communication-total": [
{
"entry": "integer"
}
],
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"is-gr-enabled": "boolean",
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"node-address": "string",
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
]
}
}
RSVP-MGMT-COUNT-PREFIX-ACL-INFO:
Prefix filtering ACL counters
- dropped: RSVP-MGMT-COUNT-PREFIX-MSG
-
Count of messages dropped
- total: RSVP-MGMT-COUNT-PREFIX-MSG
-
Count of total messages
- forwarded: RSVP-MGMT-COUNT-PREFIX-MSG
-
Count of messages which got forwarded
- locally-destined: RSVP-MGMT-COUNT-PREFIX-MSG
-
Count of locally destined messages
Example
{
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
RSVP-MGMT-NBR-COMPACT:
Compact Info for RSVP Neighbor
- interface-neighbor-list-compact: RSVP-MGMT-IF-NBR-COMPACT
-
Compact list of I/F Neighbors
-
RSVP-MGMT-IF-NBR-COMPACT - node-address: string
-
Neighbor node address
Example
{
"interface-neighbor-list-compact": [
{
"neighbor-interface-name": "string",
"interface-neighbor-address": "string"
}
],
"node-address": "string"
}
GLOBAL-NEIGHBOR-DETAIL-TABLE:
Common node of rsvp, rsvp-standby
- global-neighbor-details: object
-
Table of detailed info about global neighbors
-
- global-neighbor-detail: object[]
-
Detail info for a single global neighbor
-
- neighbor-address: string
-
Address of global neighbor
Example
{
"global-neighbor-details": {
"global-neighbor-detail": [
{
"neighbor-address": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"restart-timer-expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"missed-hellos": "integer",
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"is-restart-timer-running": "boolean",
"neighbor-hello-state": [
{
"entry": "string"
}
],
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer",
"restart-state": "string",
"hello-interval": "integer",
"lost-communication-total": [
{
"entry": "integer"
}
],
"is-gr-enabled": "boolean",
"interface-neighbor": [
{
"entry": "string"
}
],
"restart-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"recovery-time": "integer",
"node-address": "string",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
}
}
]
}
}
RSVP-MGMT-GLBL-BW-POOL-INFO:
Global B/W pool information
- is-bc1-percent-configured: boolean
-
Is BC1 default I/F percent configured
- max-res-pool-percent: integer
-
Maxium reservable I/F percent B/W
- is-bc0-percent-configured: boolean
-
Is BC0 default I/F percent configured
- bc0-percent: integer
-
BC0 I/F percent B/W
- bc1-percent: integer
-
BC1 I/F percent B/W
- is-max-res-pool-percent-configured: boolean
-
Is maximum reservable default I/F percent configured
- bandwidth-configuration-model: string rdm, mam, not-set
-
Bandwith configuration model currently in use (MAM/RDM)
Example
{
"is-bc1-percent-configured": "boolean",
"max-res-pool-percent": "integer",
"is-bc0-percent-configured": "boolean",
"bc0-percent": "integer",
"bc1-percent": "integer",
"is-max-res-pool-percent-configured": "boolean",
"bandwidth-configuration-model": "string"
}
RSVP-MGMT-PROTECTION-LINK-FLAGS:
RSVP PROTECTION Object Link Flags
- reserved-bit2: boolean
-
Reserved Bit 2
- reserved-bit1: boolean
-
Reserved Bit 1
- unprotected: boolean
-
LSP should not use any Link Layer Protection
- ded1-plus1: boolean
-
Dedicated 1+1 Protection
- enhanced: boolean
-
Indicates Enhanced Protection Scheme
- shared: boolean
-
Shared Link Layer Protection
- extra-traffic: boolean
-
LSP should use Links that are protecting other (primary) traffic
- ded1-to1: boolean
-
Dedicated 1:1 Protection
Example
{
"reserved-bit2": "boolean",
"reserved-bit1": "boolean",
"unprotected": "boolean",
"ded1-plus1": "boolean",
"enhanced": "boolean",
"shared": "boolean",
"extra-traffic": "boolean",
"ded1-to1": "boolean"
}
SESSION-DETAILED-TABLE:
Common node of rsvp, rsvp-standby
- session-detaileds: object
-
Table of detailed info about sessions
-
- session-detailed: object[]
-
Detailed info about session
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- extended-tunnel-id: string
-
Extended Tunnel ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
Example
{
"session-detaileds": {
"session-detailed": [
{
"compact": {
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"psb-rsb-info": [
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer"
}
}
}
]
}
]
}
]
}
}
RSVP-MGMT-GENERIC-LABEL:
Union of different RSVP Generic Label types
- generic-label-type: string rsvp-mgmt-label-type-gmpls
-
GenericLabelType
- generalized-label: RSVP-MGMT-GENERALIZED-LABEL
-
Generalized Label
Example
{
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
HELLO-INSTANCE-BRIEF-TABLE:
Common node of rsvp, rsvp-standby
- hello-instance-briefs: object
-
Table of brief info about hello instances
-
- hello-instance-brief: object[]
-
Brief info for a single hello instance
-
- destination-address: string
-
Destination Address
- source-address: string
-
Source Address
Example
{
"hello-instance-briefs": {
"hello-instance-brief": [
{
"destination-address": "string",
"source-address": "string",
"lost-communication-total": "integer",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"neighbor-hello-state": "string",
"instance-type": "string"
}
]
}
}
COUNTERS:
Common node of rsvp, rsvp-standby
- counters: object
-
Counters
-
- interface-messages: object
-
Table of message counters
-
- interface-message: object[]
-
Interface message counters
-
- interface-name: string
-
Interface Name. 'None' is used internally where the true interface is unknown (e.g. for routed packets)
- message-summary: RSVP-MGMT-COUNT-MESSAGE
-
Summary information for all RSVP message counters
- event-syncs: object
-
Table containing event sync counters
-
- event-sync: object[]
-
Event sync counters
-
- interface-name: string
-
Interface Name
- database: RSVP-MGMT-ALL-DB-COUNTERS
-
Summary information for all RSVP database counters
- issu: RSVP-SYNC-COUNT-INFO
-
Summary information for all RSVP ISSU counters
- prefix-filtering: object
-
Prefix filtering counters
-
- interfaces: object
-
Interface specific prefix filtering counters
-
- interfaces: object
-
Table of interface specific prefix filtering counters
-
- interface: object[]
-
Prefix filtering counters for a specific interface
-
- interface-name: string
-
Interface Name. 'None' is used internally where the true interface is unknown (e.g. for routed packets)
- summary: RSVP-MGMT-COUNT-PREFIX-INTERFACE-INFO
-
Summary of prefix filtering counts for all interfaces
- accesses: object
-
AccessList specific prefix filtering counters
-
- access: object[]
-
Prefix filtering counters for a specific AccessList
-
- access-list-name: string
-
AccessList Name
- interface-events: object
-
Event counters
-
- interface-event: object[]
-
Event counters for an interface
-
- interface-name: string
-
Interface Name. 'None' is used internally where the true interface is unknown (e.g. for routed packets)
- nsr: RSVP-SYNC-COUNT-INFO
-
Summary information for all RSVP NSR counters
- out-of-resource: object
-
Out of resource counters
-
- interfaces: object
-
Interface specific out of resource counters
-
- interfaces: object
-
Table of interface specific out of resource counters
-
- interface: object[]
-
Out of resource counters for a specific interface
-
- interface-name: string
-
Interface Name. 'None' is used internally where the true interface is unknown (e.g. for routed packets)
- summary: RSVP-MGMT-COUNTERS-OOR
-
Summary of out of resource counts for all interfaces
Example
{
"counters": {
"interface-messages": {
"interface-message": [
{
"interface-name": "string",
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
]
},
"message-summary": {
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer"
}
}
}
}
interface-neighbor-briefs_schema:
Table of brief info about I/F neighbors
- interface-neighbor-brief: RSVP-MGMT-NBR-COMPACT
-
Brief info for a single interface neighbor
-
RSVP-MGMT-NBR-COMPACT
Example
{
"interface-neighbor-brief": [
{
"interface-neighbor-list-compact": [
{
"neighbor-interface-name": "string",
"interface-neighbor-address": "string"
}
],
"node-address": "string"
}
]
}
controller-summaries_schema:
Table of summary info about RSVP-enabled controllers
- controller-summary: RSVP-MGMT-INTERFACE-SUMMARY
-
Summary info about an RSVP-enabled controller
-
RSVP-MGMT-INTERFACE-SUMMARY
Example
{
"controller-summary": [
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
]
}
authentication-briefs_schema:
Table for Authentication related information
- authentication-brief: RSVP-MGMT-AUTHENTICATION-COMPACT
-
Brief Authentication information
-
RSVP-MGMT-AUTHENTICATION-COMPACT
Example
{
"authentication-brief": [
{
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
}
]
}
session-briefs_schema:
Table of brief info about sessions
- session-brief: RSVP-MGMT-SESSION-COMPACT
-
Brief info about session
-
RSVP-MGMT-SESSION-COMPACT
Example
{
"session-brief": [
{
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
}
]
}
psb-detaileds_schema:
Table of detailed info about path state blocks
- psb-detailed: RSVP-MGMT-PATH-DETAIL
-
Detailed info for a single path state block
-
RSVP-MGMT-PATH-DETAIL
Example
{
"psb-detailed": [
{
"input-interface": "string",
"in-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"is-out-ero-valid": "boolean",
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"policy-source-info": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"out-ero": [
{
"unnumbered-ero-sub-object": {
"status": "string",
"ero-interface-id": "integer",
"is-strict-route": "boolean",
"ero-router-id": "string"
},
"ipv4ero-sub-object": {
"prefix-length": "integer",
"ero-address": "string",
"is-strict-route": "boolean"
},
"ero-type": "string"
}
],
"backup-tunnel-name": "string",
"policy-query-flags": {
"is-bypass": "boolean",
"is-report-required": "boolean",
"is-resync": "boolean",
"is-needed": "boolean"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
}
}
]
}
controller-detaileds_schema:
Table of detailed info about RSVP-enabled controllers
- controller-detailed: RSVP-MGMT-INTERFACE-DETAIL
-
Detailed info about an RSVP-enabled controller
-
RSVP-MGMT-INTERFACE-DETAIL
Example
{
"controller-detailed": [
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
]
}
rsb-detaileds_schema:
Table of detailed info about reservation state blocks
- rsb-detailed: RSVP-MGMT-RESERVATION-DETAIL
-
Detailed info for a single reservation state block
-
RSVP-MGMT-RESERVATION-DETAIL
Example
{
"rsb-detailed": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"label-info": {
"is-valid": "boolean",
"lsp-wrap-label": "string",
"local-downstream-label": "string",
"generic-local-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-recovery-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"outgoing-downstream-label": "string",
"local-upstream-label": "string",
"generic-merge-point-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"recovery-label": "string",
"outgoing-upstream-label": "string",
"generic-outgoing-downstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"generic-local-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
},
"merge-point-label": "string",
"generic-outgoing-upstream-label": {
"generic-label-type": "string",
"generalized-label": {
"value": [
{
"entry": "integer"
}
]
}
}
},
"input-adjusted-interface": "string",
"filter": {
"rsvp-filter": {}
}
}
]
}
interface-summaries_schema:
Table of summary info about RSVP-enabled interfaces
- interface-summary: RSVP-MGMT-INTERFACE-SUMMARY
-
Summary info about an RSVP-enabled interface
-
RSVP-MGMT-INTERFACE-SUMMARY
Example
{
"interface-summary": [
{
"reservations-in": "integer",
"reservations-out": "integer",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"paths-out": "integer",
"interface-name-xr": "string",
"paths-in": "integer"
}
]
}
hello-instance-briefs_schema:
Table of brief info about hello instances
- hello-instance-brief: RSVP-MGMT-HELLO-INSTANCE-COMPACT
-
Brief info for a single hello instance
-
RSVP-MGMT-HELLO-INSTANCE-COMPACT
Example
{
"hello-instance-brief": [
{
"lost-communication-total": "integer",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"neighbor-hello-state": "string",
"instance-type": "string"
}
]
}
authentication-details_schema:
Table for detailed authentication related information
- authentication-detail: RSVP-MGMT-AUTHENTICATION-DETAIL
-
Brief Authentication information
-
RSVP-MGMT-AUTHENTICATION-DETAIL
Example
{
"authentication-detail": [
{
"lifetime-left": "integer",
"challenge-status": "string",
"key-digest-info": "integer",
"key-status": "integer",
"auth-compact": {
"neighbor-address": "string",
"direction": "string",
"key-source": "string",
"key-type": "string",
"key-id-valid": "integer",
"destination-address-xr": "string",
"source-address-xr": "string",
"key-id": "integer"
},
"direction-info": {
"receive-info": {
"sequence-window-size": "integer",
"sequence": "integer",
"sequence-window-count": "integer",
"sequence-window": [
{
"entry": "integer"
}
],
"counters": {
"authentication-received-no-integrity": "integer",
"authentication-received-incomplete": "integer",
"authentication-received-valid-messages": "integer",
"authentication-received-sequence-number-duplicate": "integer",
"authentication-received-sequence-number-outof-range": "integer",
"authentication-received-challenge-timeouts": "integer",
"authentication-received-challenges-response-duplicate": "integer",
"authentication-received-challenges-resent": "integer",
"authentication-received-challenge-response": "integer",
"authentication-received-response-late": "integer",
"authentication-received-challenges-sent": "integer",
"authentication-received-bad-digest": "integer",
"authentication-received-during-challenge": "integer",
"authentication-received-wrong-challenges-response": "integer",
"authentication-received-bad-message-format": "integer",
"authentication-received-wrong-digest-type": "integer"
}
},
"send-info": {
"sequence": "integer",
"counters": {
"authentication-challenge-responses-sent": "integer",
"authentication-sent": "integer",
"authentication-send-challenges-received": "integer",
"authentication-failures": "integer"
}
},
"auth-direction": "string"
},
"lifetime": "integer"
}
]
}
rsb-briefs_schema:
Table of brief info about reservation state blocks
- rsb-brief: RSVP-MGMT-RESERVATION-COMPACT
-
Brief info for a single reservation state block
-
RSVP-MGMT-RESERVATION-COMPACT
Example
{
"rsb-brief": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
]
}
counters_schema:
Counters
- interface-messages: object
-
Table of message counters
-
- interface-message: RSVP-MGMT-COUNT-MESSAGE
-
Interface message counters
-
RSVP-MGMT-COUNT-MESSAGE
- message-summary: RSVP-MGMT-COUNT-MESSAGE
-
Summary information for all RSVP message counters
- event-syncs: object
-
Table containing event sync counters
-
- event-sync: RSVP-MGMT-EVENT-COUNT-INFO
-
Event sync counters
-
RSVP-MGMT-EVENT-COUNT-INFO
- database: RSVP-MGMT-ALL-DB-COUNTERS
-
Summary information for all RSVP database counters
- issu: RSVP-SYNC-COUNT-INFO
-
Summary information for all RSVP ISSU counters
- prefix-filtering: object
-
Prefix filtering counters
-
- interfaces: object
-
Interface specific prefix filtering counters
-
- interfaces: object
-
Table of interface specific prefix filtering counters
-
- interface: RSVP-MGMT-COUNT-PREFIX-INTERFACE-INFO
-
Prefix filtering counters for a specific interface
-
RSVP-MGMT-COUNT-PREFIX-INTERFACE-INFO
- summary: RSVP-MGMT-COUNT-PREFIX-INTERFACE-INFO
-
Summary of prefix filtering counts for all interfaces
- accesses: object
-
AccessList specific prefix filtering counters
-
- access: RSVP-MGMT-COUNT-PREFIX-ACL-INFO
-
Prefix filtering counters for a specific AccessList
-
RSVP-MGMT-COUNT-PREFIX-ACL-INFO
- interface-events: object
-
Event counters
-
- interface-event: RSVP-MGMT-EVENT-COUNT-INFO
-
Event counters for an interface
-
RSVP-MGMT-EVENT-COUNT-INFO
- nsr: RSVP-SYNC-COUNT-INFO
-
Summary information for all RSVP NSR counters
- out-of-resource: object
-
Out of resource counters
-
- interfaces: object
-
Interface specific out of resource counters
-
- interfaces: object
-
Table of interface specific out of resource counters
-
- interface: RSVP-MGMT-COUNTERS-OOR
-
Out of resource counters for a specific interface
-
RSVP-MGMT-COUNTERS-OOR
- summary: RSVP-MGMT-COUNTERS-OOR
-
Summary of out of resource counts for all interfaces
Example
{
"interface-messages": {
"interface-message": [
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
]
},
"message-summary": {
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer"
}
}
}
interface-messages_schema:
Table of message counters
- interface-message: RSVP-MGMT-COUNT-MESSAGE
-
Interface message counters
-
RSVP-MGMT-COUNT-MESSAGE
Example
{
"interface-message": [
{
"transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"retransmitted-messages": "integer",
"rate-limited-messages": "integer",
"received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-received-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"bundle-transmitted-messages": {
"ack": "integer",
"challenge": "integer",
"reservation-confirm": "integer",
"bundle": "integer",
"response": "integer",
"srefresh": "integer",
"path-error": "integer",
"reservation-error": "integer",
"reservation": "integer",
"path": "integer",
"path-tear": "integer",
"hello": "integer",
"reservation-tear": "integer"
},
"out-of-order-messages": "integer"
}
]
}
prefix-filtering_schema:
Prefix filtering counters
- interfaces: object
-
Interface specific prefix filtering counters
-
- interfaces: object
-
Table of interface specific prefix filtering counters
-
- interface: RSVP-MGMT-COUNT-PREFIX-INTERFACE-INFO
-
Prefix filtering counters for a specific interface
-
RSVP-MGMT-COUNT-PREFIX-INTERFACE-INFO
- summary: RSVP-MGMT-COUNT-PREFIX-INTERFACE-INFO
-
Summary of prefix filtering counts for all interfaces
- accesses: object
-
AccessList specific prefix filtering counters
-
- access: RSVP-MGMT-COUNT-PREFIX-ACL-INFO
-
Prefix filtering counters for a specific AccessList
-
RSVP-MGMT-COUNT-PREFIX-ACL-INFO
Example
{
"interfaces": {
"interfaces": {
"interface": [
{
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
]
},
"summary": {
"default-action-dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"default-action-processed": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
},
"accesses": {
"access": [
{
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer"
}
}
]
}
}
accesses_schema:
AccessList specific prefix filtering counters
- access: RSVP-MGMT-COUNT-PREFIX-ACL-INFO
-
Prefix filtering counters for a specific AccessList
-
RSVP-MGMT-COUNT-PREFIX-ACL-INFO
Example
{
"access": [
{
"dropped": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"total": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"forwarded": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
},
"locally-destined": {
"total": "integer",
"path": "integer",
"reservation-confirm": "integer",
"path-tear": "integer"
}
}
]
}
interfaces_schema:
Table of interface specific out of resource counters
- interface: RSVP-MGMT-COUNTERS-OOR
-
Out of resource counters for a specific interface
-
RSVP-MGMT-COUNTERS-OOR
Example
{
"interface": [
{
"dropped-path-messages": "integer"
}
]
}
out-of-resource_schema:
Out of resource counters
- interfaces: object
-
Interface specific out of resource counters
-
- interfaces: object
-
Table of interface specific out of resource counters
-
- interface: RSVP-MGMT-COUNTERS-OOR
-
Out of resource counters for a specific interface
-
RSVP-MGMT-COUNTERS-OOR
- summary: RSVP-MGMT-COUNTERS-OOR
-
Summary of out of resource counts for all interfaces
Example
{
"interfaces": {
"interfaces": {
"interface": [
{
"dropped-path-messages": "integer"
}
]
},
"summary": {
"dropped-path-messages": "integer"
}
}
}
interface-events_schema:
Event counters
- interface-event: RSVP-MGMT-EVENT-COUNT-INFO
-
Event counters for an interface
-
RSVP-MGMT-EVENT-COUNT-INFO
Example
{
"interface-event": [
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
]
}
event-syncs_schema:
Table containing event sync counters
- event-sync: RSVP-MGMT-EVENT-COUNT-INFO
-
Event sync counters
-
RSVP-MGMT-EVENT-COUNT-INFO
Example
{
"event-sync": [
{
"nac-ks": "integer",
"expired-paths": "integer",
"expired-reservations": "integer"
}
]
}
interface-detaileds_schema:
Table of detailed info about RSVP-enabled interfaces
- interface-detailed: RSVP-MGMT-INTERFACE-DETAIL
-
Detailed info about an RSVP-enabled interface
-
RSVP-MGMT-INTERFACE-DETAIL
Example
{
"interface-detailed": [
{
"interface-name-xr": "string",
"integrity-send-password": "string",
"expiry-interval": "string",
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"pacing-timer-state": "string",
"summary-refresh-max-size": "integer",
"pacing-message-rate": "integer",
"refresh-interval": "string",
"pacing-messages": "string",
"expiry-drops-tolerated": "string",
"retransmit-time": "integer",
"out-of-band-expiry-drops-tolerated": "integer",
"ack-max-size": "integer",
"expiry-timer-state": "string",
"integrity-receive-password-optional": "integer",
"out-of-band-refresh-interval": "integer",
"bundle-message-max-size": "integer",
"ack-hold-time": "integer",
"refresh-timer-state": "string",
"summary-refresh-timer-state": "string",
"flags": {
"is-rel-s-refresh-enabled": "boolean",
"is-interface-down": "boolean",
"is-backup-tunnel": "boolean",
"is-mpls-enabled": "boolean",
"is-s-refresh-enabled": "boolean",
"is-refresh-enabled": "boolean",
"is-pacing-enabled": "boolean",
"is-non-default-vrf": "boolean",
"is-refresh-reduction-enabled": "boolean",
"is-message-bundling-enabled": "boolean",
"is-interface-created": "boolean",
"is-rsvp-configured": "boolean"
},
"pacing-interval": "integer",
"integrity-receive-password": "string",
"signalling-ip-tos": "integer",
"expiry-states": "string",
"neighbor-array": [
{
"neighbor-address": "string",
"outgoing-states": "string",
"expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"message-ids": "integer",
"neighbor-message-id": [
{
"message-id": "string"
}
],
"is-neighbor-refresh-reduction-capable": "boolean"
}
]
}
]
}
controller-briefs_schema:
Table of brief info about RSVP-enabled controller
- controller-brief: RSVP-MGMT-INTERFACE-COMPACT
-
Brief info about an RSVP-enabled controller
-
RSVP-MGMT-INTERFACE-COMPACT
Example
{
"controller-brief": [
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
]
}
hello-interface-instance-briefs_schema:
Table of brief info about i/f-based hello instances
- hello-interface-instance-brief: RSVP-MGMT-HELLO-IF-INSTANCE-COMPACT
-
Brief info for a single interface-based hello instance
-
RSVP-MGMT-HELLO-IF-INSTANCE-COMPACT
Example
{
"hello-interface-instance-brief": [
{
"instance-type": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string"
}
]
}
hello-interface-instance-details_schema:
Table of detailed info about i/f-based hello instances
- hello-interface-instance-detail: RSVP-MGMT-HELLO-IF-INSTANCE-DETAIL
-
Detailed info for a single interface-based hello instance
-
RSVP-MGMT-HELLO-IF-INSTANCE-DETAIL
Example
{
"hello-interface-instance-detail": [
{
"last-message-sent-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-messages-received": "integer",
"hello-global-neighbor-id": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"source-address-xr": "string",
"destination-instance": "integer",
"instance-type": "string",
"source-instance": "integer",
"hello-messages-sent": "integer"
}
]
}
interface-neighbor-details_schema:
Table of detailed info about I/F neighbors
- interface-neighbor-detail: RSVP-MGMT-NBR-DETAIL
-
Detailed info for a single interface neighbor
-
RSVP-MGMT-NBR-DETAIL
Example
{
"interface-neighbor-detail": [
{
"interface-neighbor-list-detail": [
{
"retransmitted-messages": "integer",
"neighbor-interface-name": "string",
"is-rr-enabled": "boolean",
"neighbor-epoch": "integer",
"interface-neighbor-address": "string",
"out-of-order-messages": "integer"
}
],
"node-address": "string"
}
]
}
nsr_schema:
RSVP NSR information
- status: RSVP-NSR-ISSU-STATUS-INFO
-
RSVP NSR status information
Example
{
"status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
}
frrs_schema:
Table of detailed info about Fast Re-route states
- frr: RSVP-MGMT-FRR-STATES-DETAIL
-
Detailed info for a single Fast Re-route state
-
RSVP-MGMT-FRR-STATES-DETAIL
Example
{
"frr": [
{
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"reservation-status": "string",
"path-status": "string"
}
]
}
request-briefs_schema:
Table of brief info about requests
- request-brief: RSVP-MGMT-REQUEST-COMPACT
-
Brief info for a request
-
RSVP-MGMT-REQUEST-COMPACT
Example
{
"request-brief": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"output-interface": "string",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
]
}
request-details_schema:
Table of detail info about requests
- request-detail: RSVP-MGMT-REQUEST-DETAIL
-
Detail info for a request
-
RSVP-MGMT-REQUEST-DETAIL
Example
{
"request-detail": [
{
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"policy-sources": {
"is-local": "boolean",
"is-cops": "boolean",
"is-cable": "boolean",
"is-default": "boolean",
"is-te-link": "boolean"
},
"psb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"rsb-key": [
{
"vrfid": "string",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"destination-port-or-tunnel-id": "integer",
"sub-group-id": "integer",
"destination-address": "string",
"session-type": "string",
"p2mp-sub-group-origin": "string",
"p2mp-id": "integer",
"source-port-or-lsp-id": "integer"
}
],
"req-flags": {
"is-rro-in-path": "boolean",
"is-send-confirm": "boolean",
"is-merge-point": "boolean",
"is-refreshing": "boolean",
"is-ack-outstanding": "boolean",
"is-retransmit": "boolean",
"is-label-request-in-path": "boolean",
"is-nack-received": "boolean",
"is-record-label-in-path": "boolean",
"is-message-id-allocated": "boolean",
"is-paced": "boolean",
"is-local-receiver": "boolean"
},
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer"
}
}
}
}
]
}
interface-briefs_schema:
Table of brief info about RSVP-enabled interfaces
- interface-brief: RSVP-MGMT-INTERFACE-COMPACT
-
Brief info about an RSVP-enabled interface
-
RSVP-MGMT-INTERFACE-COMPACT
Example
{
"interface-brief": [
{
"bandwidth-information": {
"dste-mode": "string",
"standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"max-pool1-bandwidth": "integer",
"allocated-bit-rate": "integer",
"max-pool0-bandwidth": "integer",
"max-flow-bandwidth": "integer",
"is-max-bc1-bandwidth-absolute": "boolean",
"is-max-bc0-bandwidth-absolute": "boolean",
"max-bandwidth": "integer"
},
"pre-standard-dste-interface": {
"is-max-bandwidth-absolute": "boolean",
"is-max-subpool-bandwidth-absolute": "boolean",
"allocated-bit-rate": "integer",
"max-flow-bandwidth": "integer",
"max-subpool-bandwidth": "integer",
"max-bandwidth": "integer"
}
},
"interface-name-xr": "string"
}
]
}
session-detaileds_schema:
Table of detailed info about sessions
- session-detailed: RSVP-MGMT-SESSION-DETAIL
-
Detailed info about session
-
RSVP-MGMT-SESSION-DETAIL
Example
{
"session-detailed": [
{
"compact": {
"rs-bs": "integer",
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"ps-bs": "integer",
"requests": "integer",
"detail-list-size": "integer"
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"psb-rsb-info": [
{
"psb-info": [
{
"rro": [
{
"srlg-rro-sub-object": {
"srl-gs": [
{
"entry": "integer"
}
]
},
"label-rro-sub-object": {
"variable-length-label": [
{
"entry": "integer"
}
],
"is-label-variable-length": "boolean",
"flags": {
"is-global-label": "boolean"
},
"label": "integer"
},
"rro-type": "string",
"ipv4rro-sub-object": {
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"rro-address": "string"
},
"unnumbered-rro-sub-object": {
"interface-id": "integer",
"flags": {
"is-node-protection-available": "boolean",
"is-protection-in-use": "boolean",
"is-node-id": "boolean",
"is-protection-available": "boolean",
"is-bandwidth-protected": "boolean"
},
"interface-address": "string"
}
}
],
"is-valid": "boolean",
"tunnel-name": "string",
"in-label": "string",
"is-bad-address": "boolean",
"incoming-interface-address": "string",
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
}
]
}
]
}
]
}
rsvp-mgmt-rev-lsp-unsupported-subobj_schema:
- entry: integer
-
rsvp mgmt rev lsp unsupported subobj
Example
{
"entry": "integer"
}
variable-length-label_schema:
- entry: integer
-
The RRO Subobject Variable Length Label
Example
{
"entry": "integer"
}
hello-instance-details_schema:
Table of detailed info about hello instances
- hello-instance-detail: RSVP-MGMT-HELLO-INSTANCE-DETAIL
-
Detailed info for a single hello instance
-
RSVP-MGMT-HELLO-INSTANCE-DETAIL
Example
{
"hello-instance-detail": [
{
"communication-lost-wrong-source-inst": "integer",
"communication-lost-reason": "string",
"destination-address-xr": "string",
"hello-interface": "string",
"destination-instance": "integer",
"instance-type": "string",
"communication-lost-time": {
"seconds": "string",
"nanoseconds": "string"
},
"hello-request-suppressed": "integer",
"communication-lost-hello-missed": "integer",
"missed-acks-allowed": "integer",
"communication-lost-neighbor-disabled-hello": "integer",
"total-communication-lost": "integer",
"communication-lost-interface-down": "integer",
"neighbor-hello-state": "string",
"hello-interval": "integer",
"source-address-xr": "string",
"source-instance": "integer",
"hello-messages-received": "integer",
"hello-instance-owner": "string",
"up-time": {
"seconds": "string",
"nanoseconds": "string"
},
"communication-lost-wrong-destination-inst": "integer",
"hello-messages-sent": "integer"
}
]
}
global-neighbor-details_schema:
Table of detailed info about global neighbors
- global-neighbor-detail: RSVP-MGMT-GLBL-NBR-DETAIL
-
Detail info for a single global neighbor
-
RSVP-MGMT-GLBL-NBR-DETAIL
Example
{
"global-neighbor-detail": [
{
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"restart-timer-expiry-time": {
"seconds": "string",
"nanoseconds": "string"
},
"missed-hellos": "integer",
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"recovery-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"is-restart-timer-running": "boolean",
"neighbor-hello-state": [
{
"entry": "string"
}
],
"pending-states": "integer",
"is-recovery-timer-running": "boolean",
"restart-time": "integer",
"restart-state": "string",
"hello-interval": "integer",
"lost-communication-total": [
{
"entry": "integer"
}
],
"is-gr-enabled": "boolean",
"interface-neighbor": [
{
"entry": "string"
}
],
"restart-time-left": {
"seconds": "string",
"nanoseconds": "string"
},
"recovery-time": "integer",
"node-address": "string",
"recovery-timer-exp-time": {
"seconds": "string",
"nanoseconds": "string"
}
}
]
}
neighbor-hello-state_schema:
- entry: string hello-state-init, hello-state-up, hello-state-down
-
Neighbor Hello state
Example
{
"entry": "string"
}
lost-communication-reason_schema:
- entry: string not-applicable, wrong-destination-instance, wrong-source-instance, hello-missed, interface-down, neighbor-disabled-hello, control-channel-down
-
Reason why communication was lost
Example
{
"entry": "string"
}
lost-communication-total_schema:
- entry: integer
-
Total number of times communication got lost
Example
{
"entry": "integer"
}
psb-briefs_schema:
Table of brief info about path state blocks
- psb-brief: RSVP-MGMT-PATH-COMPACT
-
Brief info for a single path state block
-
RSVP-MGMT-PATH-COMPACT
Example
{
"psb-brief": [
{
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"input-interface": "string",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session-attribute": {
"reservation-priority": "integer",
"setup-priority": "integer",
"sess-attribute-flags": {
"is-local-protect": "boolean",
"is-node-protect": "boolean",
"is-bandwidth-protect": "boolean",
"is-shared-explicit-requested": "boolean",
"is-record-labels": "boolean"
}
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
]
}
global-neighbor-briefs_schema:
Table of brief info about global neighbors
- global-neighbor-brief: RSVP-MGMT-GLBL-NBR-COMPACT
-
Brief info for a single global neighbor
-
RSVP-MGMT-GLBL-NBR-COMPACT
Example
{
"global-neighbor-brief": [
{
"restart-state": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"lost-communication-total": [
{
"entry": "integer"
}
],
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"is-gr-enabled": "boolean",
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"node-address": "string",
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
]
}
rsvp_schema:
rsvp
- issu: object
-
RSVP ISSU information
-
- status: RSVP-NSR-ISSU-STATUS-INFO
-
RSVP ISSU status information
- pxsb-details: object
-
Table of detailed PXSB info
-
- pxsb-detail: object[]
-
Detailed PXSB info
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
- rxsb-details: object
-
Table of detailed RXSB info
-
- rxsb-detail: object[]
-
Detailed RXSB info
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
- bw-pool-info: RSVP-MGMT-GLBL-BW-POOL-INFO
-
All B/W Pool info
Example
{
"issu": {
"status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
},
"pxsb-details": {
"pxsb-detail": [
{
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {}
}
}
}
]
},
"global-neighbor-briefs": {
"global-neighbor-brief": [
{
"neighbor-address": "string",
"restart-state": "string",
"global-neighbor-flags": {
"is-application-mpls": "boolean",
"is-application-ouni": "boolean"
},
"lost-communication-reason": [
{
"entry": "string"
}
],
"lost-communication-total": [
{
"entry": "integer"
}
],
"lost-communication-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"is-gr-enabled": "boolean",
"local-node-address": [
{
"entry": "string"
}
],
"up-time": [
{
"seconds": "string",
"nanoseconds": "string"
}
],
"node-address": "string",
"neighbor-hello-state": [
{
"entry": "string"
}
]
}
]
}
}
issu_schema:
RSVP ISSU information
- status: RSVP-NSR-ISSU-STATUS-INFO
-
RSVP ISSU status information
Example
{
"status": {
"role": "string",
"idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
},
"previous-idt-status": {
"withdraw-time": "integer",
"idt-start-time": "integer",
"idt-end-time": "integer",
"declare-time": "integer",
"not-ready-reason": "string",
"sync-status": "string"
}
}
}
pxsb-details_schema:
Table of detailed PXSB info
- pxsb-detail: object[]
-
Detailed PXSB info
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"pxsb-detail": [
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"input-interface": "string",
"dynamic-state": "integer",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"hop": {
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
]
}
pxsb-detail_schema:
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"generic-traffic-spec": {
"tspec-type": "string",
"intsrv-tspec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
},
"g709otn-tspec": {
"traffic-nvc": "integer",
"traffic-multiplier": "integer",
"traffic-bit-rate": "integer",
"traffic-signal-type": "integer"
}
},
"template": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"input-interface": "string",
"dynamic-state": "integer",
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"hop": {
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
},
"traffic-spec": {
"traffic-max-burst": "integer",
"traffic-max-unit": "integer",
"traffic-average-rate": "integer",
"traffic-peak-rate": "integer",
"traffic-min-unit": "integer"
}
}
rxsb-details_schema:
Table of detailed RXSB info
- rxsb-detail: object[]
-
Detailed RXSB info
-
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"rxsb-detail": [
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"dynamic-state": "integer",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"hop": {
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}
]
}
rxsb-detail_schema:
- destination-port: integer
-
Destination Port
- protocol: integer
-
Protocol
- source-address: string
-
Source Address
- extended-tunnel-id: string
-
Extended Tunnel ID
- sub-group-origin: string
-
Subgroup Origin
- sub-group-id: integer
-
Subgroup ID
- vrf-name: string
-
VRF Name
- destination-address: string
-
Destination Address
- session-type: string ipv4, p2p-lsp-ipv4, ouni-ipv4, p2mp-lsp-ipv4
-
Session Type
- p2mp-id: integer
-
P2MP ID
- source-port: integer
-
Source Port
Example
{
"destination-port": "integer",
"protocol": "integer",
"source-address": "string",
"extended-tunnel-id": "string",
"sub-group-origin": "string",
"sub-group-id": "integer",
"vrf-name": "string",
"destination-address": "string",
"session-type": "string",
"p2mp-id": "integer",
"source-port": "integer",
"rsvp-header": {
"rsvp-version": "integer",
"ip-ttl": "integer",
"ip-tos": "integer",
"rsvp-header-flags": "integer",
"ip-source-address": "string",
"rsvp-message-type": "integer",
"rsvp-ttl": "integer"
},
"flow-spec": {
"flow-peak-rate": "integer",
"flow-max-unit": "integer",
"flow-max-burst": "integer",
"flow-requested-rate": "integer",
"flow-average-rate": "integer",
"flow-qos": "string",
"flow-slack": "integer",
"flow-min-unit": "integer"
},
"style": {
"reservation-type": "string"
},
"input-interface": "string",
"dynamic-state": "integer",
"filter": {
"rsvp-filter": {
"udp-ipv4-session": {
"source-port": "integer",
"source-address": "string"
},
"p2mp-ipv4-session": {
"source-port": "integer",
"p2mp-sub-group-origin": "string",
"sub-group-id": "integer",
"source-address": "string"
},
"filter-type": "string"
}
},
"s2l-sub-lsp": {
"s2l-destination-address": "string"
},
"session": {
"rsvp-session": {
"ipv4-lsp-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-tunnel-id": "string"
},
"ipv4-uni-session": {
"tunnel-id": "integer",
"destination-address": "string",
"extended-address": "string"
},
"session-type": "string",
"ipv4": {
"destination-port": "integer",
"protocol": "integer",
"destination-address": "string"
},
"ipv4-p2mp-lsp-session": {
"tunnel-id": "integer",
"p2mp-id": "integer",
"extended-tunnel-id": "string"
}
}
},
"hop": {
"neighbor-address": "string",
"neighbor-logical-interface-name": "string"
},
"generic-flow-spec": {
"g709otn-flow-spec": {
"flow-bit-rate": "integer",
"flow-signal-type": "integer",
"flow-multiplier": "integer",
"flow-nvc": "integer"
},
"flow-spec-type": "string"
}
}